ruboty-toggle_switch 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 580bf6e33db15308f664caee452443305ef7c62a
-  data.tar.gz: 45b97438c8fa479f90585533bf967e7906b242e4
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDhkNmU5ZGE4MGUyMTQ0ZWM1YmRjNDY4Nzc0MWNlNmY2MDQzYWE0Nw==
+  data.tar.gz: !binary |-
+    ZDA1ZTc3ZjMyMGYyZGFlMWU5ZjBmZjc0N2Y5YWEzMTE4NzE0NTI0YQ==
 SHA512:
-  metadata.gz: 82aa4cd51bb856c6069176874809f718915018e7a629031d3b37335306ad40f0a49b1d7870af029ca0cdb8441c93062dfb81fec01122c9cc13e1ad3e1e33d803
-  data.tar.gz: 1bb763dfe7eff9d94f5b38c1784b2a85540d8feaa77f4236b7fde00c68a9a6249b943aef1c7c2f4bc96891ae9146066cbce4f6f96b4373c3d647e91f409f488c
+  metadata.gz: !binary |-
+    NzI5YmFkOTRhYmQ0NWMwZTc5YzZmM2MzMDk2N2Q0NTgxMjgzZGIxMGU0ZDhi
+    YTk5ODU0YzU5YmI0MzM0NTUzNDJmNWQwMjMyMWNlZTAzZGEwNDEzZWQ0YzI5
+    ZDQxNThkMWZiNzkxMDJjY2RkZjZlZWM4ZWVmM2FhMTQ5Njk3MDU=
+  data.tar.gz: !binary |-
+    OTRhYzI3NjY0MjVhZmJmYWU4OWNhMjBiMDk2OTBjMDYwYTcxZTE3Y2M4MjZk
+    Mzg5NTNlZjllMDA4M2ZlMGUzYmY2ODYwZGQ5OTJmMDNjOGM4YzhmNzVlMzFm
+    MGVlZDFlNTk0ZjE3YmUzMGNkMWZiMmNkNzI3YTZhMmZlMzVlMDQ=

data/.travis.yml

@@ -3,3 +3,11 @@ rvm:
   - 2.3.0
 cache: bundler
 sudo: false
+deploy:
+  provider: rubygems
+  api_key:
+    secure: lpWEA88TEJ3dajzamEJyqfZJmFV44E/UDfvAjEvf2+tnZxA4E9goOlIP3iS8QZwaWHTCPbB8PUWMRX6Zumdbcnzx314i9dFcH+oiiypJO+Y2UxViGuB1WWwVye4EEEcsRCE82g5qi73/ALuFRi3TtQgRtzCgfTgzDGA2uS/gZtj9Al3B7AytdvmExCy5j6vB7WrU7YjTOFWGrqYQGSMo+ccS2fwJL2kMYAEBgF26Sx1oX9uhhokVvlA0kyFc04WFpdq7tAJxZYkGe4sFIMJ9+d9x5ZytDLjv96RWEl0z7Jxj1rOcUtc/zoFgd4jyszn8rMKkCeJSSYUCgZmVjz8D4iw0xXWRdnuuxjL856/PW3mN8ETRxlRWKG0ohdR5Tgk26reWlBBUWkvPBtjSkukO13DWWO5R7FJOawjA5y3iN24MjPbQOgUvC+YtvANjbIaAyyrZL4oCahgZyfDBeq3i22kE1cYc5oMQr5MfSoG+4XpspkpFgr3b0bmkANSD4fx0b/Ey0YbUUx+Glbx0StosH8DyUQvSdvBwbGfla6KJXRaUDZMNm130bmzBTbhnhQVEvWS6ahuZ7e5vgeouaqsZ6qexUf/XYpfHLCmRMGktGWaak4aL9j6qe9sP7j96jIoIlokBnKWMtmC2jaJClR5deZtQSpAHBWk4oLp4laZZ92k=
+  gem: ruboty-toggle_switch
+  on:
+    tags: true
+    repo: takai/ruboty-toggle_switch

data/README.md

@@ -14,6 +14,14 @@ gem 'ruboty-toggle_switch'
 
 ## Usage
 
+```
+ruboty: toggle <switch> (on|off) - Toggle key status.
+ruboty: show <switch> status     - Show the current status.
+ruboty: list switches            - List the statuses of switches
+```
+
+## Examples
+
 ```
 > ruboty: toggle switch on
 switch is now on.
@@ -23,6 +31,8 @@ switch is on on Apr 27 at 06:29.
 switch is now off.
 > ruboty: show switch status
 switch is off for good sleeping on Apr 27 at 06:30.
+> ruboty: list switches
+- switch is off.
 ```
 
 ## API
@@ -34,3 +44,5 @@ storage = Ruboty::ToggleSwitch::Storage.new(robot.brain)
 record  = storage['switch']
 record.status # => 'on' or 'off'
 ```
+
+http://www.rubydoc.info/github/takai/ruboty-toggle_switch/master/Ruboty/ToggleSwitch/Storage

data/lib/ruboty/toggle_switch/storage.rb

@@ -3,47 +3,62 @@ module Ruboty
     class Storage
       include Enumerable
 
-      Record = Struct.new(:state, :from, :at, :note)
+      # Represents a switch.
+      Switch = Struct.new(:state, :from, :at, :note)
 
       NAMESPACE = 'ruboty-toggle_switch-storage'
 
+      # Returns a new instance of Storage
+      # @param [Ruboty::Brain] brain
       def initialize(brain)
         @brain = brain
       end
 
+      # Returns the switch to which the specified key is mapped.
+      #
+      # @return [Switch, nil] the switch or nil
       def [](key)
-        records[key]
+        switches[key]
       end
 
+      # Update the switch which is associated with the specified key.
+      #
+      # @param [String] key the key for the switch.
+      # @param [Hash] value the value to update the switch.
+      # @option value [String] :state "on" or "off".
+      # @option value [String] :from a name of the message sender.
       def []=(key, value)
-        records[key] = Record.new(value[:state], value[:from], Time.now, value[:note])
+        switches[key] = Switch.new(value[:state], value[:from], Time.now, value[:note])
       end
 
+      # Returns true if the switch is 'on'.
+      #
+      # @return [Boolean] true if the state of the switch is "on"
       def on?(key)
         state_for(key) == 'on'
       end
 
+      # Returns true if the switch is 'off'.
+      #
+      # @return [Boolean] true if the state of the switch is "off"
       def off?(key)
         state_for(key) == 'off'
       end
 
+      # Yields each pair of the key and switch.
       def each
-        records.each do |entry|
+        switches.each do |entry|
           yield(*entry)
         end
       end
 
-      def size
-        records.size
-      end
-
       private
 
       def state_for(key)
-        records[key] && records[key].state
+        switches[key] && switches[key].state
       end
 
-      def records
+      def switches
         @brain.data[NAMESPACE] ||= {}
       end
     end

data/lib/ruboty/toggle_switch/version.rb

@@ -1,5 +1,5 @@
 module Ruboty
   module ToggleSwitch
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   end
 end

data/ruboty-toggle_switch.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruboty-toggle_switch
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Naoto Takai
@@ -14,58 +14,72 @@ dependencies:
   name: ruboty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: ruboty-toggle_switch allows you to toggle switch on/off.
 email:
 - takai@recompile.net
@@ -73,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -96,19 +110,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ruboty-toggle_switch allows you to toggle switch on/off.
 test_files: []
-has_rdoc: