LittleWeasel 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.idea/.rakeTasks CHANGED
@@ -4,4 +4,4 @@ You are allowed to:
4
4
  1. Remove rake task
5
5
  2. Add existing rake tasks
6
6
  To add existing rake tasks automatically delete this file and reload the project.
7
- --><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build LittleWeasel-0.0.1.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Build and install LittleWeasel-0.0.1.gem into system gems" fullCmd="install" taksId="install" /><RakeTask description="Create tag v0.0.1 and build and push LittleWeasel-0.0.1.gem to Rubygems" fullCmd="release" taksId="release" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /></RakeGroup></Settings>
7
+ --><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build LittleWeasel-1.0.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Build and install LittleWeasel-1.0.0.gem into system gems" fullCmd="install" taksId="install" /><RakeTask description="Create tag v1.0.0 and build and push LittleWeasel-1.0.0.gem to Rubygems" fullCmd="release" taksId="release" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /></RakeGroup></Settings>
data/.idea/workspace.xml CHANGED
@@ -3,13 +3,12 @@
3
3
  <component name="ChangeListManager">
4
4
  <list default="true" id="34d4ec05-51d8-442a-84a5-75b5005cedf0" name="Default" comment="">
5
5
  <change type="MODIFICATION" beforePath="$PROJECT_DIR$/lib/LittleWeasel.rb" afterPath="$PROJECT_DIR$/lib/LittleWeasel.rb" />
6
- <change type="MODIFICATION" beforePath="$PROJECT_DIR$/spec/checker/checker_spec.rb" afterPath="$PROJECT_DIR$/spec/checker/checker_spec.rb" />
7
- <change type="MODIFICATION" beforePath="$PROJECT_DIR$/lib/LittleWeasel/version.rb" afterPath="$PROJECT_DIR$/lib/LittleWeasel/version.rb" />
6
+ <change type="MODIFICATION" beforePath="$PROJECT_DIR$/README.md" afterPath="$PROJECT_DIR$/README.md" />
8
7
  </list>
9
8
  <ignored path="LittleWeasel.iws" />
10
9
  <ignored path=".idea/workspace.xml" />
11
- <file path="/Dummy.txt" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372295761358" ignored="false" />
12
- <file path="/LittleWeasel.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372298548295" ignored="false" />
10
+ <file path="/Dummy.txt" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372805608148" ignored="false" />
11
+ <file path="/LittleWeasel.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372810862469" ignored="false" />
13
12
  <file path="/spec_helper.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1371776194745" ignored="false" />
14
13
  <file path="/little_weasel.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1371781900009" ignored="false" />
15
14
  <file path="/checker_spec.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372298875670" ignored="false" />
@@ -17,7 +16,7 @@
17
16
  <file path="/LittleWeasel.gemspec" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1371779509067" ignored="false" />
18
17
  <file path="/.gitignore" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1371780237152" ignored="false" />
19
18
  <file path="$PROJECT_DIR$/../Junk/Gemfile" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1371782248484" ignored="false" />
20
- <file path="/README.md" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372033430783" ignored="false" />
19
+ <file path="/README.md" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372808528240" ignored="false" />
21
20
  <file path="/spec.opts" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1371941082027" ignored="false" />
22
21
  <file path="/temp.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1371942034978" ignored="false" />
23
22
  <file path="$PROJECT_DIR$/vendor/bundle/gems/rake-10.1.0/test/test_rake_test_task.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1371942034978" ignored="false" />
@@ -79,12 +78,14 @@
79
78
  <file path="$PROJECT_DIR$/../monkeyengine/lib/MonkeyAction/monkey_action_dead.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372026814108" ignored="false" />
80
79
  <file path="$PROJECT_DIR$/../monkeyengine/test/rspec/monkey_action_eat_spec.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372027845209" ignored="false" />
81
80
  <file path="/monkey_action_eat_spec.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372027770209" ignored="false" />
82
- <file path="$PROJECT_DIR$/../monkeyengine/Gemfile" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372029000393" ignored="false" />
81
+ <file path="$PROJECT_DIR$/../monkeyengine/Gemfile" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372299316528" ignored="false" />
83
82
  <file path="/action.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372029144020" ignored="false" />
84
83
  <file path="$PROJECT_DIR$/../monkeyengine/lib/Action/action.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372029144020" ignored="false" />
85
- <file path="$PROJECT_DIR$/../monkeyengine/bin/monkey_run.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372033010115" ignored="false" />
86
- <file path="/monkey_run.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372033000238" ignored="false" />
87
- <file path="/fragment.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372297872713" ignored="false" />
84
+ <file path="$PROJECT_DIR$/../monkeyengine/bin/monkey_run.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372300906872" ignored="false" />
85
+ <file path="/monkey_run.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372300906872" ignored="false" />
86
+ <file path="/fragment.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372300782061" ignored="false" />
87
+ <file path="/version.rb" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372727849994" ignored="false" />
88
+ <file path="/com.mohojo-werks.bootstrap.css.scss" changelist="34d4ec05-51d8-442a-84a5-75b5005cedf0" time="1372805715738" ignored="false" />
88
89
  <option name="TRACKING_ENABLED" value="true" />
89
90
  <option name="SHOW_DIALOG" value="false" />
90
91
  <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -107,25 +108,25 @@
107
108
  <file leaf-file-name="LittleWeasel.rb" pinned="false" current="false" current-in-tab="false">
108
109
  <entry file="file://$PROJECT_DIR$/lib/LittleWeasel.rb">
109
110
  <provider selected="true" editor-type-id="text-editor">
110
- <state line="21" column="64" selection-start="411" selection-end="411" vertical-scroll-proportion="0.0">
111
+ <state line="56" column="5" selection-start="1825" selection-end="1825" vertical-scroll-proportion="0.0">
111
112
  <folding />
112
113
  </state>
113
114
  </provider>
114
115
  </entry>
115
116
  </file>
116
- <file leaf-file-name="checker_spec.rb" pinned="false" current="false" current-in-tab="false">
117
- <entry file="file://$PROJECT_DIR$/spec/checker/checker_spec.rb">
117
+ <file leaf-file-name="Gemfile" pinned="false" current="true" current-in-tab="true">
118
+ <entry file="file://$PROJECT_DIR$/Gemfile">
118
119
  <provider selected="true" editor-type-id="text-editor">
119
- <state line="50" column="17" selection-start="1432" selection-end="1432" vertical-scroll-proportion="0.0">
120
+ <state line="8" column="27" selection-start="188" selection-end="188" vertical-scroll-proportion="0.25157234">
120
121
  <folding />
121
122
  </state>
122
123
  </provider>
123
124
  </entry>
124
125
  </file>
125
- <file leaf-file-name="version.rb" pinned="false" current="true" current-in-tab="true">
126
- <entry file="file://$PROJECT_DIR$/lib/LittleWeasel/version.rb">
126
+ <file leaf-file-name="README.md" pinned="false" current="false" current-in-tab="false">
127
+ <entry file="file://$PROJECT_DIR$/README.md">
127
128
  <provider selected="true" editor-type-id="text-editor">
128
- <state line="1" column="18" selection-start="38" selection-end="38" vertical-scroll-proportion="0.031446543">
129
+ <state line="25" column="15" selection-start="468" selection-end="468" vertical-scroll-proportion="0.0">
129
130
  <folding />
130
131
  </state>
131
132
  </provider>
@@ -149,7 +150,6 @@
149
150
  <component name="IdeDocumentHistory">
150
151
  <option name="changedFiles">
151
152
  <list>
152
- <option value="$PROJECT_DIR$/spec/spec_helper.rb" />
153
153
  <option value="$PROJECT_DIR$/lib/LittleWeasel/checker.rb" />
154
154
  <option value="$PROJECT_DIR$/LittleWeasel.gemspec" />
155
155
  <option value="$PROJECT_DIR$/.gitignore" />
@@ -161,10 +161,11 @@
161
161
  <option value="$PROJECT_DIR$/test/spec.opts" />
162
162
  <option value="$PROJECT_DIR$/spec/.rspec" />
163
163
  <option value="$PROJECT_DIR$/.rspec" />
164
- <option value="$PROJECT_DIR$/README.md" />
165
- <option value="$PROJECT_DIR$/lib/LittleWeasel.rb" />
166
164
  <option value="$PROJECT_DIR$/spec/checker/checker_spec.rb" />
165
+ <option value="$PROJECT_DIR$/Gemfile" />
167
166
  <option value="$PROJECT_DIR$/lib/LittleWeasel/version.rb" />
167
+ <option value="$PROJECT_DIR$/README.md" />
168
+ <option value="$PROJECT_DIR$/lib/LittleWeasel.rb" />
168
169
  </list>
169
170
  </option>
170
171
  </component>
@@ -278,7 +279,29 @@
278
279
  <recent name="$PROJECT_DIR$/test" />
279
280
  </key>
280
281
  </component>
281
- <component name="RunManager" selected="RSpec.checker_spec">
282
+ <component name="RunManager" selected="Gem Command.Start Yard Server">
283
+ <configuration default="true" type="CommandRunConfigurationType" factoryName="Gem Command">
284
+ <module name="" />
285
+ <COMMAND_RUN_CONFIGURATION NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
286
+ <COMMAND_RUN_CONFIGURATION NAME="WORK DIR" VALUE="" />
287
+ <COMMAND_RUN_CONFIGURATION NAME="SHOULD_USE_SDK" VALUE="false" />
288
+ <COMMAND_RUN_CONFIGURATION NAME="ALTERN_SDK_NAME" VALUE="" />
289
+ <COMMAND_RUN_CONFIGURATION NAME="myPassParentEnvs" VALUE="true" />
290
+ <envs />
291
+ <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="false" />
292
+ <EXTENSION ID="JRubyRunConfigurationExtension" />
293
+ <EXTENSION ID="RubyCoverageRunConfigurationExtension" enabled="false" sample_coverage="true" track_test_folders="true" runner="rcov">
294
+ <COVERAGE_PATTERN ENABLED="true">
295
+ <PATTERN REGEXPS="/.rvm/" INCLUDED="false" />
296
+ </COVERAGE_PATTERN>
297
+ </EXTENSION>
298
+ <EXTENSION ID="org.jetbrains.plugins.ruby.motion.run.MotionSimulatorRunExtension" />
299
+ <COMMAND_CONFIG_SETTINGS_ID NAME="GEM_NAME" VALUE="" />
300
+ <COMMAND_CONFIG_SETTINGS_ID NAME="EXECUTABLE_NAME" VALUE="" />
301
+ <COMMAND_CONFIG_SETTINGS_ID NAME="EXECUTABLE_ARGS" VALUE="" />
302
+ <COMMAND_CONFIG_SETTINGS_ID NAME="WORKING_DIR" VALUE="" />
303
+ <method />
304
+ </configuration>
282
305
  <configuration default="true" type="RSpecRunConfigurationType" factoryName="RSpec">
283
306
  <predefined_log_file id="RUBY_RSPEC" enabled="true" />
284
307
  <module name="LittleWeasel" />
@@ -355,6 +378,30 @@
355
378
  <RTEST_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_OPTIONS" VALUE="" />
356
379
  <method />
357
380
  </configuration>
381
+ <configuration default="false" name="Start Yard Server" type="CommandRunConfigurationType" factoryName="Gem Command" singleton="true">
382
+ <module name="LittleWeasel" />
383
+ <COMMAND_RUN_CONFIGURATION NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
384
+ <COMMAND_RUN_CONFIGURATION NAME="WORK DIR" VALUE="$PROJECT_DIR$" />
385
+ <COMMAND_RUN_CONFIGURATION NAME="SHOULD_USE_SDK" VALUE="false" />
386
+ <COMMAND_RUN_CONFIGURATION NAME="ALTERN_SDK_NAME" VALUE="" />
387
+ <COMMAND_RUN_CONFIGURATION NAME="myPassParentEnvs" VALUE="true" />
388
+ <envs />
389
+ <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="true" />
390
+ <EXTENSION ID="JRubyRunConfigurationExtension" />
391
+ <EXTENSION ID="RubyCoverageRunConfigurationExtension" enabled="false" sample_coverage="true" track_test_folders="true" runner="rcov">
392
+ <COVERAGE_PATTERN ENABLED="true">
393
+ <PATTERN REGEXPS="/.rvm/" INCLUDED="false" />
394
+ </COVERAGE_PATTERN>
395
+ </EXTENSION>
396
+ <EXTENSION ID="org.jetbrains.plugins.ruby.motion.run.MotionSimulatorRunExtension" />
397
+ <COMMAND_CONFIG_SETTINGS_ID NAME="GEM_NAME" VALUE="yard" />
398
+ <COMMAND_CONFIG_SETTINGS_ID NAME="EXECUTABLE_NAME" VALUE="yard" />
399
+ <COMMAND_CONFIG_SETTINGS_ID NAME="EXECUTABLE_ARGS" VALUE="server --reload" />
400
+ <COMMAND_CONFIG_SETTINGS_ID NAME="WORKING_DIR" VALUE="server --reload" />
401
+ <RunnerSettings RunnerId="RubyRunner" />
402
+ <ConfigurationWrapper RunnerId="RubyRunner" />
403
+ <method />
404
+ </configuration>
358
405
  <configuration default="false" name="checker_spec" type="RSpecRunConfigurationType" factoryName="RSpec">
359
406
  <predefined_log_file id="RUBY_RSPEC" enabled="true" />
360
407
  <module name="LittleWeasel" />
@@ -391,8 +438,9 @@
391
438
  <ConfigurationWrapper RunnerId="RubyRunner" />
392
439
  <method />
393
440
  </configuration>
394
- <list size="1">
395
- <item index="0" class="java.lang.String" itemvalue="RSpec.checker_spec" />
441
+ <list size="2">
442
+ <item index="0" class="java.lang.String" itemvalue="Gem Command.Start Yard Server" />
443
+ <item index="1" class="java.lang.String" itemvalue="RSpec.checker_spec" />
396
444
  </list>
397
445
  </component>
398
446
  <component name="ShelveChangesManager" show_recycled="false" />
@@ -429,7 +477,7 @@
429
477
  <window_info id="TODO" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="6" side_tool="false" content_ui="tabs" />
430
478
  <window_info id="Database" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="3" side_tool="false" content_ui="tabs" />
431
479
  <window_info id="Structure" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.25" sideWeight="0.5" order="1" side_tool="false" content_ui="tabs" />
432
- <window_info id="Project" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.28550932" sideWeight="0.6697613" order="0" side_tool="false" content_ui="combo" />
480
+ <window_info id="Project" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.29411766" sideWeight="0.6697613" order="0" side_tool="false" content_ui="combo" />
433
481
  <window_info id="Debug" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.39920425" sideWeight="0.5" order="3" side_tool="false" content_ui="tabs" />
434
482
  <window_info id="Favorites" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="2" side_tool="true" content_ui="tabs" />
435
483
  <window_info id="Event Log" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="7" side_tool="true" content_ui="tabs" />
@@ -509,9 +557,7 @@
509
557
  <component name="editorHistoryManager">
510
558
  <entry file="file://$PROJECT_DIR$/.gitignore">
511
559
  <provider selected="true" editor-type-id="text-editor">
512
- <state line="5" column="11" selection-start="47" selection-end="47" vertical-scroll-proportion="0.0">
513
- <folding />
514
- </state>
560
+ <state line="5" column="11" selection-start="47" selection-end="47" vertical-scroll-proportion="0.0" />
515
561
  </provider>
516
562
  </entry>
517
563
  <entry file="file://$PROJECT_DIR$/vendor/bundle/gems/rake-10.1.0/install.rb">
@@ -534,23 +580,11 @@
534
580
  <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0" />
535
581
  </provider>
536
582
  </entry>
537
- <entry file="file://$PROJECT_DIR$/Gemfile">
538
- <provider selected="true" editor-type-id="text-editor">
539
- <state line="5" column="12" selection-start="110" selection-end="110" vertical-scroll-proportion="0.0">
540
- <folding />
541
- </state>
542
- </provider>
543
- </entry>
544
583
  <entry file="file://$PROJECT_DIR$/spec/spec_helper.rb">
545
584
  <provider selected="true" editor-type-id="text-editor">
546
585
  <state line="0" column="73" selection-start="73" selection-end="73" vertical-scroll-proportion="0.0" />
547
586
  </provider>
548
587
  </entry>
549
- <entry file="file://$PROJECT_DIR$/LittleWeasel.gemspec">
550
- <provider selected="true" editor-type-id="text-editor">
551
- <state line="11" column="95" selection-start="550" selection-end="550" vertical-scroll-proportion="0.0" />
552
- </provider>
553
- </entry>
554
588
  <entry file="file://$PROJECT_DIR$/vendor/bundle/gems/rake-10.1.0/lib/rake/file_utils.rb">
555
589
  <provider selected="true" editor-type-id="text-editor">
556
590
  <state line="54" column="0" selection-start="1689" selection-end="1689" vertical-scroll-proportion="0.020604396" />
@@ -563,42 +597,52 @@
563
597
  </entry>
564
598
  <entry file="file://$PROJECT_DIR$/.gitignore">
565
599
  <provider selected="true" editor-type-id="text-editor">
566
- <state line="17" column="3" selection-start="165" selection-end="165" vertical-scroll-proportion="0.0">
600
+ <state line="17" column="3" selection-start="165" selection-end="165" vertical-scroll-proportion="0.0" />
601
+ </provider>
602
+ </entry>
603
+ <entry file="file://$PROJECT_DIR$/lib/dictionary">
604
+ <provider selected="true" editor-type-id="text-editor">
605
+ <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="-352.64462" />
606
+ </provider>
607
+ </entry>
608
+ <entry file="file://$PROJECT_DIR$/LittleWeasel.gemspec">
609
+ <provider selected="true" editor-type-id="text-editor">
610
+ <state line="11" column="95" selection-start="550" selection-end="550" vertical-scroll-proportion="0.0">
567
611
  <folding />
568
612
  </state>
569
613
  </provider>
570
614
  </entry>
571
- <entry file="file://$PROJECT_DIR$/lib/dictionary">
615
+ <entry file="file://$PROJECT_DIR$/lib/LittleWeasel/version.rb">
572
616
  <provider selected="true" editor-type-id="text-editor">
573
- <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="-352.64462">
617
+ <state line="0" column="25" selection-start="25" selection-end="25" vertical-scroll-proportion="0.0">
574
618
  <folding />
575
619
  </state>
576
620
  </provider>
577
621
  </entry>
578
- <entry file="file://$PROJECT_DIR$/README.md">
622
+ <entry file="file://$PROJECT_DIR$/spec/checker/checker_spec.rb">
579
623
  <provider selected="true" editor-type-id="text-editor">
580
- <state line="3" column="6" selection-start="72" selection-end="72" vertical-scroll-proportion="0.0">
624
+ <state line="10" column="37" selection-start="268" selection-end="268" vertical-scroll-proportion="0.0">
581
625
  <folding />
582
626
  </state>
583
627
  </provider>
584
628
  </entry>
585
- <entry file="file://$PROJECT_DIR$/lib/LittleWeasel.rb">
629
+ <entry file="file://$PROJECT_DIR$/README.md">
586
630
  <provider selected="true" editor-type-id="text-editor">
587
- <state line="21" column="64" selection-start="411" selection-end="411" vertical-scroll-proportion="0.0">
631
+ <state line="25" column="15" selection-start="468" selection-end="468" vertical-scroll-proportion="0.0">
588
632
  <folding />
589
633
  </state>
590
634
  </provider>
591
635
  </entry>
592
- <entry file="file://$PROJECT_DIR$/spec/checker/checker_spec.rb">
636
+ <entry file="file://$PROJECT_DIR$/lib/LittleWeasel.rb">
593
637
  <provider selected="true" editor-type-id="text-editor">
594
- <state line="50" column="17" selection-start="1432" selection-end="1432" vertical-scroll-proportion="0.0">
638
+ <state line="56" column="5" selection-start="1825" selection-end="1825" vertical-scroll-proportion="0.0">
595
639
  <folding />
596
640
  </state>
597
641
  </provider>
598
642
  </entry>
599
- <entry file="file://$PROJECT_DIR$/lib/LittleWeasel/version.rb">
643
+ <entry file="file://$PROJECT_DIR$/Gemfile">
600
644
  <provider selected="true" editor-type-id="text-editor">
601
- <state line="1" column="18" selection-start="38" selection-end="38" vertical-scroll-proportion="0.031446543">
645
+ <state line="8" column="27" selection-start="188" selection-end="188" vertical-scroll-proportion="0.25157234">
602
646
  <folding />
603
647
  </state>
604
648
  </provider>
data/Gemfile CHANGED
@@ -5,3 +5,5 @@ gemspec
5
5
 
6
6
  ruby '1.9.3'
7
7
  gem "rspec", "~> 2.13.0"
8
+ gem "yard", "~> 0.8.6.2"
9
+ gem "redcarpet", "~> 2.3.0"
data/README.md CHANGED
@@ -21,11 +21,13 @@ Or install it yourself as:
21
21
 
22
22
  require 'LittleWeasel'
23
23
 
24
- LittleWeasel::Checker.instance.exists?('word') # true if exists in the dictionary, false otherwise.
24
+ LittleWeasel::Checker.instance.exists?('word', options|nil) # true if exists in the dictionary, false otherwise.
25
+
26
+ Hash{Symbol => Boolean}
25
27
 
26
28
  ## Contributing
27
29
 
28
- Not open to contributions just yet, sorry :)
30
+ Not taking contributions just yet.
29
31
 
30
32
  ## License
31
33
 
data/lib/LittleWeasel.rb CHANGED
@@ -3,9 +3,13 @@ require "LittleWeasel/version"
3
3
 
4
4
  module LittleWeasel
5
5
 
6
+ # Provides methods to interrogate the dictionary.
6
7
  class Checker
7
8
  include Singleton
8
9
 
10
+ # Returns the dictionary.
11
+ #
12
+ # @return [Hash] the dictionary.
9
13
  attr_reader :dictionary
10
14
 
11
15
  private
@@ -14,6 +18,7 @@ module LittleWeasel
14
18
 
15
19
  public
16
20
 
21
+ # The constructor
17
22
  def initialize
18
23
  @options = {exclude_alphabet: false}
19
24
  @alphabet_exclusion_list = %w{ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z }
@@ -21,6 +26,13 @@ module LittleWeasel
21
26
  load
22
27
  end
23
28
 
29
+ # Interrogates the dictionary to determine whether or not [word] exists.
30
+ #
31
+ # @param [String] word the word to interrogate
32
+ # @param [Hash] options options to apply to this query (see #options=). Options passed to this
33
+ # method are applied for this query only.
34
+ #
35
+ # @return [Boolean] true if *word* exists, false otherwise.
24
36
  def exists?(word, options=nil)
25
37
  options = options || @options
26
38
 
@@ -30,12 +42,29 @@ module LittleWeasel
30
42
  dictionary.has_key? word
31
43
  end
32
44
 
33
- # {exclude_alphabet: true} will return exist? == false for a-z, A-Z
34
- # {exclude_alphabet: false} will return exist? == true for a-z, A-Z
45
+ # Sets the global options for this gem.
46
+ #
47
+ # @param [Hash] options options that should apply to all subsequent calls to method *exists?* (see #exists?).
48
+ # Options set via this property apply to all subsequent queries.
49
+ # @option options [Boolean] :exclude_alphabet (false) If false, letters of the alphabet are considered words.
50
+ # For example, LittleWeasel::Checker.instance.exists?('A'), will return true.
51
+ #
52
+ # @return [Hash] The options
53
+ #
54
+ # @example
55
+ # LittleWeasel::Checker.instance.options({exclude_alphabet:true})
56
+ # LittleWeasel::Checker.instance.exists?('A') # false
57
+ #
58
+ # LittleWeasel::Checker.instance.options({exclude_alphabet:false})
59
+ # LittleWeasel::Checker.instance.exists?('A') # true
60
+ #
35
61
  def options=(options)
36
62
  @options = options
37
63
  end
38
64
 
65
+ # Gets the global options currently set for this gem.
66
+ #
67
+ # @return [Hash] The options
39
68
  def options
40
69
  @options
41
70
  end
@@ -1,3 +1,4 @@
1
+ # The version of this gem
1
2
  module LittleWeasel
2
- VERSION = "1.0.0"
3
+ VERSION = "1.0.1"
3
4
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: LittleWeasel
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2013-06-27 00:00:00.000000000 Z
12
+ date: 2013-07-03 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: bundler