galife: マニュアル

ラベル マニュアル の投稿を表示しています。すべての投稿を表示

GitHub のプロジェクトページを自動生成 & 公開する方法

GitHub で作成したアプリやツールを WEBページにして公開したい！！そんなことを実現できる機能として「GitHub Pages」があります。 GitHub Pages ではプロジェクトに関連するホームページ、WEBサイトの公開、運用ができます。

この、GitHub Pages を作る方法は以下の２種類があります。ここでは、GitHub Pages を自動生成、公開する手順を見ていきます。

手動生成 & 公開
自動生成 & 公開

自動生成はテンプレートがあるため、最初からそれなりの WEBページ作成が可能なので、個人的にはオススメです。

自動生成 & 公開

WEBページを作成したいプロジェクトを開きます。
プロジェクトの "Settings" を開きます。
"Options" を選択します。
中段までスクロールし、"Automatic Page Generator" を選択します。
以下の項目を修正して、"Continue to Lyout" を選択します。
- Project Name：プロジェクト名
- Tagline：プロジェクトの説明
- Body：本文（"Load README.md" を選択するとラク）
- Google Analytics Tracking ID：Google アナリティクスのトラッキングID（必要であれば）
好きなレイアウトを選択します。（選択すると下段にプレビューします。）
"PUBLISH+" を選択して完了します。
WEBページが公開されるまで 10分程度待ちます。 10分後にメッセージ中にある URL を選択するとページが公開されています。

GitHub Pages は "gh-pages" という名前のブランチで運用されます。ページができあがった後は、"gh-pages" ブランチを編集することで、WEBページが更新されます。

今回、参考にしたサイトは以下の通りです。

GitHub Pages

GitHub のプロジェクトページを手動公開する方法

この、GitHub Pages を作る方法は以下の２種類があります。ここでは、GitHub Pages を手動生成、公開する手順を見ていきます。

手動生成 & 公開
自動生成 & 公開

手動生成 & 公開

GitHub for Windows を利用して作業を行っていきます。 GitHub for Windows のインストールについてはこちらをご参照ください。

GitHub for Windows を起動します。
GitHub ページを作成したいレポジトリを右クリック、"open a shell here" を選択します。
Power Shell が立ち上がるので、以下のコマンドを入力します。
これにより gh-pages という名前のブランチが作られます。
```
[master]> git checkout --orphan gh-pages
```
続いて以下のコマンドを入力します。
これにより "." を含むファイルが削除されます。
```
[gh-pages]> git rm -rf .
```
GitHub for Windows へ戻り、ブランチを作ったレポジトリを開きます。
レポジトリは空なので、エクスプローラでローカルフォルダを開きます。
（選択されているブランチが "gh-pages" になっているハズです。）
開いたエクスプローラの場所で WEBページを作成します。
（とりあえず今回は index.html のみ作成しました。）
GitHub for Windows へ戻り、変更をコミットします。
"publish..." を選択します。
作業は以上で完了です。
10分後 に次の URL へアクセスして公開されていることを確認します。
http://ユーザー名.github.io/レポジトリ名/

今回、参考にしたサイトは以下の通りです。

GitHub Pages

マークダウン記法まとめ

記法例	サンプル
# 見出し１	見出し１
## 見出し２	見出し２
### 見出し３	見出し３

記法例	サンプル
***

記法例	サンプル
文字列	文字列

記法例	サンプル
文字列	文字列

記法例	サンプル
* 項目１ * 項目２ * 項目３ * 項目３－１ * 項目３－２	項目１項目２項目３項目３－１項目３－２
1. 項目１ 2. 項目２ 3. 項目３ 1. 項目３－１ 2. 項目３－２	項目１項目２項目３項目３－１項目３－２

記法例	サンプル
> アル晴れた日のこと > 魔法以上のユカイが > > 限りなく降り注ぐ > > 不可能じゃないわ	アル晴れた日のこと魔法以上のユカイが限りなく降り注ぐ不可能じゃないわ

記法例	サンプル
`<div>hoge</div>`	`<div>hoge</div>`

記法例	サンプル
function foobar() { window.alert('hello world'); }	function () { window.alert('hello world'); }

記法例	サンプル
[Google](http://google.com/)	Google

記法例	サンプル
![Blogger](https://www.blogger.com/img/logo-16.png)

記法例	サンプル
文字列	文字列

jasmine 日本語 API リファレンス (jasmine.Spy)

Spy クラス

Jasmine.Spy はスタブ、スパイ、フェイク、またはモックとして動作するテストの代役です。

Spy は expect より前のスペック処理中に生成してください。これにより、Jasmine標準 expectation 構文中での利用状況を調べることができます。 Spy は該当する関数が呼ばれたかどうか、また、どのようなパラメータで呼ばれたかを調べます。

Spy はすべてのスペックが終了時に破棄されます。

注意： new jasmine.Spy() を直接呼び出さないでください。 Spy は spyOn、jasmine.createSpy または jasmine.createSpyObj を用いて生成してください。

名前空間：jasmine

バージョン：1.2.0

概要

コンストラクタ

<public>	Spy([name]) Spyクラスのインスタンスを初期化します

プロパティ

<private>	identity : string 指定されていた場合、Spyに名前を設定。指定がない場合は 'unknown'。
<private>	isSpy : boolean このオブジェクトが Spy であるかどうか。
<private>	baseObj : object このオブジェクトがラップする元オブジェクト。
<private>	methodName : string このオブジェクトがラップする関数名。
<private>	originalValue : function このオブジェクトがラップする関数。baseObj[methodName]と同じ。
<private>	plan : function このオブジェクトが呼ばれたとき実行される関数。
<private>	mostRecentCall : object このオブジェクトを最も呼び出したオブジェクトのトラッキング
<private>	argsForCall : array このオブジェクトを呼び出したときの引数を呼び出した回数順に保持する。
<private>	calls : array

メソッド

<public>	andCallThrough() : jasmine.Spy Spy が呼ばれたとき実実装を呼び出すよう設定します。
<public>	andReturn(value) : jasmine.Spy Spy が呼ばれたときの戻り値を設定します。
<public>	andThrow(exceptionMsg) : jasmine.Spy Spy が呼ばれたとき発生させる例外を設定します。
<public>	andCallFake(fakeFunc) : jasmine.Spy Spy が呼ばれたとき代わりに実行される関数を設定します。
<public>	reset() : void Spy を再利用するため、トラッキング変数を初期化します。

詳細

コンストラクタ

Spy コンストラクタ

Spy クラスの新しいインスタンスを初期化します。

構文：

function Spy (
    {string}       [name]
)

パラメタ：

{string}[name]: 一意に特定する名前。デフォルトは"unknown"。

メソッド

andCallThrough() メソッド

Spy が呼ばれたとき、実実装を呼び出すよう設定します。

構文：

public {jasmine.Spy} andCallThrough (
)

パラメタ：

: なし。

戻り値：

{jasmine.Spy}: jasmine.Spy オブジェクト。

使用例：

var foo = {
    bar: function () {
        // 何か処理。
    }
};

// 既に存在するプロパティ foo.bar に対して Spy を設定します。
spyOn(foo, 'bar').andCallThrough();

andReturn(value) メソッド

Spy が呼ばれたとき、指定された値が必ず返されるよう設定されます。

構文：

public {jasmine.Spy} andReturn (
    {object}    value
)

パラメタ：

{object}value: Spy が実行されたときの戻り値。

戻り値：

{jasmine.Spy}: jasmine.Spy オブジェクト。

使用例：

var foo = {
    bar: function () {
        // 何か処理。
    }
};

// 既に存在するプロパティ foo.bar に対して Spy を設定します。
spyOn(foo, 'bar').andReturn('baz');

andThrow(exceptionMsg) メソッド

Spy が呼ばれたとき、必ず指定されたメッセージの例外が発生するよう設定します。

構文：

public {jasmine.Spy} andThrow (
    {string}    exceptionMsg
)

パラメタ：

{string}exceptionMsg: 発生させる例外のメッセージ。

戻り値：

{jasmine.Spy}: jasmine.Spy オブジェクト。

使用例：

var foo = {
    bar: function () {
        // 何か処理。
    }
};

// 既に存在するプロパティ foo.bar に対して Spy を設定します。
spyOn(foo, 'bar').andThrow('baz');

andCallFake(fakeFunc) メソッド

Spy が呼ばれたとき、必ず指定された代替関数が実行されるよう設定します。

構文：

public {jasmine.Spy} andCallFake (
    {function}  exceptionMsg
)

パラメタ：

{string}exceptionMsg: 代わりに実行される関数。

戻り値：

{jasmine.Spy}: jasmine.Spy オブジェクト。

reset() メソッド

Spy を再利用するため、トラッキング変数を初期化します。

構文：

public {void} reset (
)

パラメタ：

: なし。

戻り値：

: なし。

jQuery プラグインの公開

GitHub for Windows を利用しながら、GitHub 上に作成した jQueryプラグインを公開してみます。

jQueryプラグイン名の付け方
jQueryプラグインの公開手順

プラグイン名の付け方

基本ルールは次の通り。

使える文字列は、英数字、ハイフン、ピリオド、アンダースコアのみです。
プラグイン名は全プラグイン（世界中で公開されているプラグイン）においてユニークな名称である必要があります。
プラグイン名とファイル名は一致させます。
例えば hoge プラグインなら jquery.hoge.js 。
特定プロジェクトで使っているプレフィックスは利用できません。
例えば jQuery UI の jquer.ui.* は使えません。

要するに、名前は早い者勝ちだそうです。ただし、名前を先にとって中身がからっぽだと、警告無しに削除するそうです。

プラグインの公開

GitHub for Windows を使いながら jQueryプラグインを公開していきます。

GitHub で jQueryプラグイン用のレポジトリを作成

まずは、公開するプラグイン自体を準備します。詳細は下記の記事または他のサイトをご参照ください。
- GitHub for windows のインストールと設定
- GitHub for Windows の使い方
GitHub のレポジトリに Post-Receiveフックを設定

ここでは、基本設定のみ（今回の目標に対して必要最低限のみ）を記載します。以下の手順は GitHub のウェブページ上で行います。
1. GitHub で公開したい jQueryプラグインのレポジトリを開きます
2. "設定（Settings）" を開きます
3. "サービスフック（Service Hooks）"をクリックします
4. "WebフックURL（WebHook URLs）"をクリックします
5. URL //plugins.jquery.com/postreceive-hook を入力します
6. 「更新（Update Settings）」をクリックします

パッケージマニュフェストファイルをレポジトリに追加

jQuery Plugins Registry はレポジトリのルートディレクトリにある *.jquery.json という名前のファイルを探します。 jQueryプラグインレポジトリのルートディレクトリに、パッケージマニフェスト仕様書に従った yourplugin.jquery.json を作成、配置します。

パッケージマニフェストファイルのサンプル

{
    "name": "depend",
    "title": "Solution for the dependency problem",
    "description": "jQuery plugin for resolve of the dependency problem about client browser or/and client platform using userAgent string.",
    "keywords": [
        "browser",
        "platform",
        "detection",
        "html5",
        "mobile",
        "tablet",
        "support"
    ],
    "version": "1.0.0",
    "author": {
        "name": "garafu",
        "url": "https://github.com/garafu"
    },
    "licenses": [
        {
            "type": "MIT",
            "url": "https://github.com/garafu/jquery.depend/blob/master/MIT-LICENSE.txt"
        }
    ],
    "bugs": "https://github.com/garafu/jquery.depend/issues",
    "homepage": "https://github.com/garafu/jquery.depend",
    "docs": "https://github.com/garafu/jquery.depend/wiki",
    "download": "https://github.com/garafu/jquery.depend",
    "dependencies": {
        "jquery": ">=1.9.1"
    }
}

パッケージマニフェストファイルの検証は "Publishing Your Plugin" 中段にある "Validate Your Manifest File Here" を利用してください。

パッケージマニフェストの仕様は "jQuery Plugin Package Manifest Specification" を参照してください。（詳細は後日気が向いたときに記載…するかも…。。）

新規バージョンタグを設定して jQueryプラグインを発行

Post-Recieve フックの設定、マニフェストファイルの作成が完了したら、いよいよ公開作業に入ります。以下の手順は GitHub for Windows （＋ PowerShell）上で行います。
1. GitHub for Windows で公開したい jQueryプラグインのレポジトリを右クリックします
2. "シェルを起動（open a shell here）" をクリックします
3. PowerShell が起動するので、以下のコマンドを実行します
```
> git tag v1.0.0
> git push origin --tags
```
  > git tag [バージョン] で指定するバージョン番号と、パッケージマニュフェストで指定するバージョン番号は一致していないと登録できません。
  
  すでに発行済みのタグ（バージョン番号）を上書きすることはできません。
  
  きちんと登録できたかどうかは jQuery Plugins Registry エラーログ末尾を確認します。

まとめ

jQueryプラグインを公開する概略手順は次の通りです。

GitHub で jQueryプラグイン用のレポジトリを作成
GitHub のレポジトリに Post-Receiveフックを設定
パッケージマニュフェストファイルをレポジトリに追加
新規バージョンタグを設定して jQueryプラグインを発行

参考にしたサイトは以下の通りです。

GitHub for Windows の使い方

GitHub for Windows を利用した、基本的な使い方を記載します。 subversion や TFS に慣れていると、理解が早い…と思います。ここでは、基本的な以下の操作を見ていきたいと思います。

新規レポジトリの作成
クローンの作成
コードの追加 & 修正
コードをコミット
タグ付け

個人的なイメージですが、"クローン(clone)" は "チェックアウト" 、"コミット(commit)" & "発行（publish）" が "チェックイン" に相当するイメージです。クローンとチェックアウトは厳密には違うと思いますが… クローンを行った後、サーバー側を他から変更してしまうと、発行（publish）するときエラーになるから要注意です。。

GitHub for Windows のインストールと設定はこちらを参照してください。

新規レポジトリの作成

"add" を選択します。
"新規レポジトリ（new repository）" ダイアログが表示されるので、次の項目を記載 or 確認します。
- "名前（name）" を記載。必須入力。
- "説明（description）" を記載。
- "保存先フォルダ" を確認。
- "GitHub へプッシュする（Push to GitHub）"にチェック。
記載 or 確認できたら、左下 "作成（CREATE）" を選択します。
新規レポジトリが追加されています。
"GitHub へプッシュする（Push to GitHub）" が選択されていると、GitHub へレポジトリの新規作成が反映されています。

クローンの作成

新規レポジトリ作成をすると、ローカルにクローンが作成されますが、元々、GitHub にしかないレポジトリだと、ローカルにクローンがありません。以下の手順で、明示的にクローンを作成します。

GitHub アカウントを選択します。
クローンを作成したいレポジトリ横にある "クローン（clone）" を選択します。
しばらくすると、クローン作成が完了します。

コードの追加 & 修正

クローンが作成されていると、ローカルに GitHub のレポジトリに対応するフォルダが作成されています。

開きたいレポジトリを右クリックし、"エクスプローラーで開く（open in explorer）" を選択します。
（※ウィルスバスターを入れていると警告がでました…が、無視しました。）
エクスプローラが開くので、開いたフォルダで適当にファイルやフォルダを作ったり修正したり…

コードをコミット

ローカルを選択します。
ローカルでコミットしたいレポジトリをダブルクリックします。
変更一覧がリストアップされるので
- コミットするファイルを選択 or 確認
- "コミットメッセージ（COMMIT MESSAGE）" を記載（必須）
- "追加説明（EXTENDED DESCRIPTION）" を記載
"コミット（COMMIT）" を選択します。
"発行（puslish）" を選択します。
（個人的には…発行（publish）というよりプッシュ（push）なイメージですが。。）
GitHub へ変更が反映されます。

タグ付け

タグ付けしたいレポジトリを右クリックします
"シェルを起動（open a shell here）" をクリックします
PowerShell が起動するので、以下のコマンドを実行します
```
> git tag 1.0.0
```
タグ付けするコマンドは > git tag [タグ名] です。上記の例ではタグ名を「1.0.0」としています。

間違えて付けたタグを消すコマンドは > git tag -d [タグ名] です。

GitHub for windows のインストールと設定

GitHub for windows を使ってみる…の前に、使える環境を整えていきます。とりあえず、CUIでもいいけど、GUIが便利そうなので、GitHub for Windows を入れてみます。ちなみに、GitHubアカウントはすでに持っている前提です。

インストール
初回起動 & 初期設定
設定変更

GitHub for Windows の使い方はこちらを参照してください。

インストール

"GitHub for Windows" をダウンロード。
※ダウンロード先はこちら。
ダウンロードした "GitHubSetup.exe" を実行。
「インストール」を選択。
しばらく待ちます...
（AWSにデータを保存してるんですね…）
インストールが終わると、初回起動になるので、初期設定をします。

初回起動 & 初期設定

GitHub アカウントは既にある前提なので、アカウントが場合は GitHub で先に作ってください。

[connect] 画面。
GitHub への接続情報を入力してログイン(LOGIN)します。
[configure] 画面。
ユーザー情報を確認、修正して続行(continue)します。
[repositories] 画面。
ローカルレポジトリの確認、反映をします。
初回はローカルにレポジトリのコピーはないはずなので、そのままスキップ(SKIP)します。
とりあえず、使える状態。

設定変更

設定変更といっても、ローカルの保存先を変更するだけです。

[tools]を展開します。
[options...]を選択します。
[default storage directory]を変更します。
左下[UPDATE]を選択して、変更を保存します。

参考までに… GitHub for Windows はローカルにキャッシュを作るそうです。（何の情報を保存しているかは分かりませんが…）そのキャッシュの保存先は下記のフォルダ以下のようです。

C:\Users\[ユーザー名]\AppData\Roaming\GitHub

ちなみに削除すると、ログイン情報とか何やらが消えて、初期状態に戻ります。

インストールと初期設定だけだと、特に問題は発生しませんでした。たぶん、普通に使えるものかと…思ってます。

これで、死んでいた自分の GitHub アカウントが動き出す…かも www

jasmine 日本語 API リファレンス (jasmine.Matchers)

概要

コンストラクタ

<public>	Matchers(env, actual, spec, [opt_isNot]) Matchersクラスのインスタンスを初期化します

プロパティ

<private>	env jasmine.Env インスタンス。
<private>	actual 実際の値。
<private>	spec jasmine.Spec インスタンス。
<private>	isNot not 修飾されているかどうか。
<private>	reportWasCalled_ : boolean

メソッド

<private> <static>	wrapInfo_
<private> <static>	matcherFn_
<public>	toBe(expected) : boolean === を用いて actual を expected と比較します。
<public>	toEqual(expected) : boolean 一般的な等号を用いて actual を expected と比較します。
<public>	toMatch(expected) : 正規表現を用いて actual を expected と比較します。
<public>	toBeDefined() : boolean actual を jasmine.undefined と比較します。
<public>	toBeUndefined() : boolean actual を jasmine.undefined と比較します。
<public>	toBeNull() : boolean actual を null と比較します。
<public>	toBeTruthy() : boolean boolean の NOT-NOT を実行して返します。
<public>	toBeFalsy() : boolean boolean の NOT を実行して返します。
<public>	toHaveBeenCalled() : boolean actual が呼び出されたかどうか、Jasmineスパイを参照します。
<public>	toHaveBeenCalledWidth() : boolean actual がパラメタ群とともに呼び出されたかどうか、Jasmineスパイを参照します。
<public>	toContain(expected) : boolean expected オブジェクトが actual 配列に含まれているかどうかを判定します。
<public>	toBeLessThan(expected) : boolean actual が expected より小さいかどうか判定します。
<public>	toBeGreaterThan(expected) : boolean actual が expected より大きいかどうか判定します。
<public>	toBeCloseTo(expected, [perceision]) : boolean actual が expected と与えられた少数桁数まで一致しているかどうかを調べます。(デフォルトでは少数第２位まで)
<public>	toThrow(expected) : boolean actual によって例外が発生するかどうか判定します。

クラス

<public>	Any
<public>	ObjectContaining

詳細

コンストラクタ

Matchers コンストラクタ

Matchers クラスの新しいインスタンスを初期化します。

構文：

function Matchers (
    {jasmine.Env}   env,
    {object}        actual,
    {jasmine.Spec}  spec,
    {boolean}       [opt_isNot]
)

パラメタ：

{jasmine.Env}env: jasmine.Envインスタンス。
{object}actual: 実際の値。テスト対象で処理された結果値。toXXX関数ではこの値に対して比較を行う。
{jasmine.Spec}spec: スペック。
{boolean}[opt_isNot]: not 修飾されているかどうか。デフォルトは false。

メソッド

toBe(expected) メソッド

actual と expected が一致するかどうか。=== を用いた比較を行います。

構文：

public {boolean} toBe (
    {object}    expected
)

パラメタ：

{object}expected: 期待する値。

戻り値：

{boolean}: actual と expected が一致するかどうか。

toEqual(expected) メソッド

actual と expected が一致するかどうか。Object、Array、Date型など、複雑なオブジェクトの比較で利用します。

構文：

public {boolean} toEqual (
    {object}    expected
)

パラメタ：

{object}expected: 期待するオブジェクト。

戻り値：

{boolean}: actual と expected が一致するかどうか。

toMatch(expected) メソッド

正規表現を用いて actual を expected と比較します。actual が expected で規定される正規表現に一致するかどうかを判定します。

構文：

public {boolean} toMatch (
    {string}    expected
)

パラメタ：

{string}expected: 正規表現文字列。

戻り値：

{boolean}: actual が expected で規定される正規表現に一致するかどうか。

toBeDefined() メソッド

actual を jasmine.undefined と比較します。

構文：

public {boolean} toBeDefined (
)

パラメタ：

: なし。

戻り値：

{boolean}: actual が undefined でないかどうか。

toBeUndefined() メソッド

actual を jasmine.undefined と比較します。actual が undefined かどうかを返します。

構文：

public {boolean} toBeUndefined (
)

パラメタ：

: なし。

戻り値：

{boolean}: actual が undefined かどうか。

toBeNull() メソッド

actual を null と比較します。

構文：

public {boolean} toBeNull (
)

パラメタ：

: なし。

戻り値：

{boolean}: actual が null かどうか。

toBeTruthy() メソッド

boolean の NOT-NOT を実行して返します。

構文：

public {boolean} toBeTruthy (
)

パラメタ：

: なし。

戻り値：

{boolean}: actual が true であるかどうか

toBeFalsy() メソッド

boolean の NOT を実行して返します。

構文：

public {boolean} toBeFlasy (
)

パラメタ：

: なし。

戻り値：

{boolean}: actual が false, undefined, null, ""(空文字) かどうか。

toHaveBeenCalled() メソッド

actual が呼び出されたかどうか、Jasmineスパイを参照します。

構文：

public {boolean} toHaveBeenCalled (
)

パラメタ：

: なし。

戻り値：

{boolean}: actual が呼び出されたかどうか。

サンプルコード：

describe("toHaveBeenCalledについて", function() {
    var foo, bar = null;

    beforeEach(function() {
        // テスト用に foo オブジェクトを作成
        foo = {
            setBar: function(value) {
                bar = value;
            }
        };

        // "toHaveBeenCalled"を利用するために Spy を準備
        spyOn(foo, 'setBar');

        // 評価対象となるメソッドを実行
        foo.setBar(123);
    });

    it("foo.setBarが呼び出された", function() {
        expect(foo.setBar).toHaveBeenCalled();    // true が戻る。
    });
}

toHaveBeenCalledWidth() メソッド

actual がパラメタ群とともに呼び出されたかどうか、Jasmineスパイを参照します。

構文：

public {boolean} toHaveBeenCalledWidth (
)

パラメタ：

: なし。

戻り値：

{boolean}: actual が呼び出されたかどうか。

toContain(expected) メソッド

expected オブジェクトが actual配列に含まれているかどうか調べます。

構文：

public {boolean} toContain (
    {object}    expected
)

パラメタ：

{object}expected: 期待するオブジェクト。

戻り値：

{boolean}: actual配列に expectedオブジェクトが含まれているかどうか。

toBeLessThan(expected) メソッド

actual が expected より小さいかどうか判定します。

構文：

public {boolean} toBeLessThan (
    {number}    expected
)

パラメタ：

{number}expected: 期待する上限値。

戻り値：

{boolean}: actual が指定された値より小さいかどうか。

toBeGreaterThan(expected) メソッド

actual が expected より大きいかどうか判定します。

構文：

public {boolean} toBeGreaterThan (
    {number}    expected
)

パラメタ：

{number}expected: 期待する下限値。

戻り値：

{boolean}: actual が指定された値より大きいかどうか。

toBeCloseTo(expected, [precision]) メソッド

actual が expected で与えられた少数桁数まで一致しているか判定します。

構文：

public {boolean} toBeCloseTo (
    {number}    expected,
    {number}    [precision]
)

パラメタ：

{number}expected: 期待する値。
{number}precision: 有効桁数。デフォルトは２(少数第２位)。

戻り値：

{boolean}: actual が指定された有効桁数まで expected と一致しているかどうか。

toThrow([expected]) メソッド

actual がエラーを発生させるかどうか判定します。

構文：

public {boolean} toThrow (
    {string}    [expected]
)

パラメタ：

{string}[expected]: 期待されるエラーメッセージ。

戻り値：

{boolean}: actual が指定されたエラーメッセージのエラーを発生させるかどうか。

サンプルコード：

if("例外を発生する", function () {
    var foo = function () {
        return 1 + 2;
    };
    expect(foo).toThrow();   // このスペックは失敗します。
});

jasmine 日本語 API リファレンス (_global_)

基本的にjasmineのソースコードにあるjsdocコメントを日本語化しています。補足 or 修正している個所もあります。日本語が変だったり、補足が変だったりと、不備があるかもしれないので、そういった場合は指摘いただけると幸いです。

概要

名前空間

<namespace>	jasmine Jasmineで利用する関数、クラスを保持します。

メソッド

<public>	afterEach スイート内の各スペック実行後に呼び出される関数。
<public>	beforeEach スイート内の各スペック実行前に呼び出される関数。
<public>	describe スペックスイートを定義します。
<public>	expect 期待値を求めるためのメソッドチェーンを開始します。
<public>	it 現在のスイートへ追加するスペックを生成します。
<public>	runs jasmineスペックの一部を定義します。
<public>	spyOn 既に存在するオブジェクトのメソッドに対してスパイを組み込みます。
<public>	waits 次のブロックへ移る前に指定された時間待ちます。
<public>	waitsFor 次のブロックへ移る前、latchFunction が true を返すまで待ちます。
<public>	xdescribe スペックスイートを無効にします。
<public>	xit 無効なjasmineスペックを生成します。

詳細

afterEach メソッド

スイート内の各スペック実行後に呼び出される関数。
スペック実行中に上書きした状態の復元に使います。

構文：

public {void} afterEach (
    {function}  afterEachFunction
)

パラメタ：

{function}afterEachFunction: 各スペック実行後に行う復元処理。

戻り値：

{void}: なし。

beforeEach メソッド

スイート内の各スペック実行前に呼び出される関数。
スペック実行の準備、前提条件の検証に使います。

構文：

public {void} beforeEach (
    {function}  beforeEachFunction
)

パラメタ：

{function}beforeEachFunction: 各スペック実行前に行う準備および検証処理。

戻り値：

{void}: なし。

describe メソッド

スペックスイートを定義します。
Jasmine環境に"description"と"スペック"を１つのスイートとして保存します。この関数中で定義される変数は、関数中で呼ばれる"beforeEach", "it", "afterEach"においてアクセスできます。 "describe"ブロックは入れ子で定義できます。これにより、いくつかのテストにおいて特別なセットアップを行うことができます。

構文：

public {jasmine.Suite} describe (
    {string}    description,
    {function}  specDefinitions
)

パラメタ：

{string}description: 文字列。通常はテスト対象となるクラス名。
{function}specDefinitions: スペックを定義する関数。

戻り値：

{jasmine.Suite}: jasmineスイートの内部表現。

expect メソッド

期待値を求めるためのメソッドチェーンを開始します。
引数として渡された Object は実際の値であり、jasmine.Matchers関数のいずれかにチェーンします。

構文：

public {jasmine.Matchers} expect (
        {object}    actual
)

パラメタ：

{object}actual: 期待値に対してテストしたい実際の値

戻り値：

{jasmine.Matchers}: マッチャー。

参照：

マッチャー(jasmine.Matchers)

it メソッド

現在のスイートへ追加するスペックを生成します。

構文：

public {jasmine.Spec} it (
        {string}    desc,
        {function}  func
)

パラメタ：

{string}desc: スペックの説明。
{function}func: スペックの前提条件と期待値を定義します。

戻り値：

{jasmine.Spec}: jasmineスペックの内部表現。

サンプルコード：

it('should be true', function() {
    expect(true).toEqual(true);
});

runs メソッド

jasmineスペックの一部を定義します。
非同期スペックにおいて、waitsまたはwaitsForと組み合わせて利用します。

構文：

public {void} runs (
    {function}  func
)

パラメタ：

{function}func: jasmineスペックの一部分を定義する関数。

戻り値：

{void}: なし。

サンプルコード：

it("should support async execution of test preparation and exepectations", function () {
    runs(function () {
        flag = false;
        value = 0;

        setTimeout(function () {
            flag = true;
        }, 500);
    });

    waitsFor(function () {
        value++;
        return flag;
    }, "The Value should be incremented", 750);

    runs(function () {
        expect(value).toBeGreaterThan(0);
    });
});

spyOnメソッド

既に存在するオブジェクトのメソッドに対してスパイを組み込みます。
スペック中でスパイを生成するために使います。

構文：

public {object} spyOn (
        {object}    obj,
        {string}    methodName
)

パラメタ：

{object}obj: 監視したい関数を持つインスタンスオブジェクト。
{string}methodName: 監視したい関数名。

戻り値：

{object}: すべてのスパイ関数が実行できるjasmineスパイオブジェクト。(引数で与えた obj に対してスパイとして拡張を行ったオブジェクト。)

参照：

スパイ(jasmine.Spy)

waits メソッド

次のブロックへ移る前に指定された時間待ちます。

構文：

public {void} waits (
        {number}    timeout
)

パラメタ：

{number}timeout: 待つ時間。単位はミリ秒。

戻り値：

{void}: なし。

waitsForメソッド

次のブロックへ移る前、latchFunction が true を返すまで待ちます。

構文：

public {void} waitsFor (
        {function}  latchFunction,
        {string}    [optional_timeoutMessage],
        {number}    [optional_timeout]
)

パラメタ：

{function}latchFunction: 待機する条件。この関数が true を返すまで waitsFor 関数は待機します。
{string}[optional_timeoutMessage]: タイムアウト時(失敗時)のメッセージ。
{number}[optional_timeout]: latchFunction を監視する時間。単位はミリ秒。

戻り値：

{void}: なし。

xdescribe メソッド

スペックスイートを無効にします。
開発中、失敗するスイートを一時的に無効にするために使います。

構文：

public {object} xdescribe (
    {string}    description,
    {function}  specDefinitions
)

パラメタ：

{string}description: 文字列。通常はテスト対象となるクラス名。
{function}specDefinitions: スペックを定義する関数。

戻り値：

{object}: jasmine.Suiteを模した空のオブジェクト。

xit メソッド

無効なjasmineスペックを生成します。
開発中、一時的にスペックを無効にする便利な関数です。

構文：

public {object} xit (
        {string}    desc,
        {function}  func
)

パラメタ：

{string}desc: スペックの説明。
{function}func: スペックの前提条件と期待値を定義します。

戻り値：

{object}: jasmine.Specを模した空のオブジェクト。

SyntaxHilighterをBloggerで利用する方法

Syntax Hilighterをどうしても使ってみたくて…

ようやく Blogger にコードが貼れるようになった。。。自分は主に Javascript を扱っているので JavaScript のみ。

function foo () {
    window.alert('bar');
}

やり方自体は、alexgorbatchev.comにあるソースコードを拝借するやり方。

galife

GitHub のプロジェクトページを自動生成 & 公開する方法

自動生成 & 公開

GitHub のプロジェクトページを手動公開する方法

手動生成 & 公開

マークダウン記法まとめ

見出し

水平線

斜体

強調

リスト

引用

インラインコード

コードブロック

アンカー

画像

改行

jasmine 日本語 API リファレンス (jasmine.Spy)

jQuery プラグインの公開

プラグイン名の付け方

プラグインの公開

まとめ

GitHub for Windows の使い方

新規レポジトリの作成

クローンの作成

コードの追加 & 修正

コードをコミット

タグ付け

GitHub for windows のインストールと設定

インストール

初回起動 & 初期設定

設定変更

jasmine 日本語 API リファレンス (jasmine.Matchers)

jasmine 日本語 API リファレンス (_global_)

SyntaxHilighterをBloggerで利用する方法

Labels

Archives

Pages

Contact