variables 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e00350ee1237f9a686c15f1b68ecdf1b4a8b907a
-  data.tar.gz: e896b8ae8384d3359f13387825e900dd6cef315c
+  metadata.gz: 5afb3ae44f42e6645bbedd2ba24dfe62fc514226
+  data.tar.gz: 56dd7414254fcc2272a1bbf71378da9193f23b0d
 SHA512:
-  metadata.gz: d33a10bb51f355d331923bd4be509141641dee0edcf5e31b3956a80d51d3ef0e44f7db7b6471c11c4736342eb8e555843bfd732df2f85bd6ae814fa8f98d385e
-  data.tar.gz: 801cc456f88824ff7ffdcb463d5c828d4c88c1cb2e1b6e7465ccee54a5c2f73e2dbeeb788546cd7e31652bf29e8ff8756a317c48ee3c7fdd2da45d25de87e49a
+  metadata.gz: 434db9ac4298434b821ededa65f017cfdbbdfd5973ff4ae2f6b1cd8abd01cc30a36c84ed3bee930d5a876247a73f10e1c836998ba9069afd6869d1a2c075520e
+  data.tar.gz: 89ec48f72918ab8ad18d5711c785269b829855b2fd3314ec66153c18e3902926ea6686f83852f483e217700db077f6681d5977b822b8f65e1bc02c9db820bb49

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    variables (0.0.0)
+    variables (0.0.1)
       abstract_class (>= 1.0.0)
 
 GEM

data/README.md

@@ -1,11 +1,26 @@
 # [![Sean Huber](https://cloud.githubusercontent.com/assets/2419/6550752/832d9a64-c5ea-11e4-9717-6f9aa6e023b5.png)](https://github.com/shuber) variables
 
-[![Build Status](https://secure.travis-ci.org/shuber/variables.svg)](http://travis-ci.org/shuber/variables) [![Code Climate](https://codeclimate.com/github/shuber/variables/badges/gpa.svg)](https://codeclimate.com/github/shuber/variables) [![Coverage](https://codeclimate.com/github/shuber/variables/badges/coverage.svg)](https://codeclimate.com/github/shuber/variables)
+[![Build Status](https://secure.travis-ci.org/shuber/variables.svg)](http://travis-ci.org/shuber/variables) [![Code Climate](https://codeclimate.com/github/shuber/variables/badges/gpa.svg)](https://codeclimate.com/github/shuber/variables) [![Coverage](https://codeclimate.com/github/shuber/variables/badges/coverage.svg)](https://codeclimate.com/github/shuber/variables) [![Gem Version](https://badge.fury.io/rb/variables.svg)](http://badge.fury.io/rb/variables)
 
 > `Variable` objects for *class* and *instance* variables
 
 Ruby already has `Method` objects, why not `Variable` objects as well?
 
+## Why?
+
+Some methods already exist for interacting with *class* and *instance* variables:
+
+* `Module#class_variable_defined?`
+* `Module#class_variable_get`
+* `Module#class_variable_set`
+* `Object#instance_variable_defined?`
+* `Object#instance_variable_get`
+* `Object#instance_variable_set`
+
+But notice that these all share a common prefix - `instance_variable_` or `class_variable_`.
+
+This feels a little [smelly](http://en.wikipedia.org/wiki/Code_smell), let's try to [DRY](http://en.wikipedia.org/wiki/Don%27t_repeat_yourself) it up with some `Variable` objects!
+
 
 ## Installation
 
@@ -38,7 +53,7 @@ user = User.new('Bob')              #=> #<User:0x007f8f6a84aa98>
 user.instance_variable_get('@name') #=> "Bob"
 ```
 
-Similar to [`Object#method`](http://ruby-doc.org/core-1.8.7/Object.html#method-i-method), a handy `instance_variable` method is available for us to use.
+Similar to [`Object#method`](http://ruby-doc.org/core-1.8.7/Object.html#method-i-method), the `instance_variable` method returns a `Variable` object.
 
 ```ruby
 name = user.instance_variable(:name) #=> #<InstanceVariable: #<User>@name>
@@ -78,13 +93,20 @@ name.fetch(:default)      #=> "Bob"
 undefined.fetch(:default) #=> :default
 ```
 
-Default values can also be defined with a `block` which is yielded the `Variable` name.
+Default values can also be defined with a `block` which is yielded with the `Variable` name.
 
 ```ruby
 name.fetch { |name| "#{name}-default" }      #=> "Bob"
 undefined.fetch { |name| "#{name}-default" } #=> "@undefined-default"
 ```
 
+The `Object#instance_variable_fetch` method allows us to `fetch` a variable's value by name.
+
+```ruby
+name.fetch                          #=> "Bob"
+user.instance_variable_fetch(:name) #=> "Bob"
+```
+
 We can update a `Variable` value by using the `set` method.
 
 ```ruby
@@ -104,18 +126,47 @@ We can even temporarily `replace` a value for the duration of a `block`.
 ```ruby
 user.instance_variable_get('@name') #=> "Bob"
 
-value = name.replace('Steve') do
+name.replace('Steve') do
   user.instance_variable_get('@name') #=> "Steve"
+end
+
+user.instance_variable_get('@name') #=> "Bob"
+```
+
+Note that when using the `block` form of `replace`, the last expression of the block is returned.
+
+```ruby
+name.replace('Steve') { 1 + 1 } #=> 2
+```
+
+The `Object#instance_variable_replace` method allows us to `replace` a variable's value by name.
 
-  'we can return a value here'
+```ruby
+user.instance_variable_get('@name') #=> "Bob"
+
+user.instance_variable_replace(:name, 'Steve') do
+  user.instance_variable_get('@name') #=> "Steve"
 end
 
 user.instance_variable_get('@name') #=> "Bob"
+```
+
+The `instance_variable_replace` method also accepts a hash of variables to `replace`.
+
+```ruby
+user.instance_variable_get('@name') #=> "Bob"
+user.instance_variable_get('@test') #=> nil
 
-value.inspect #=> "we can return a value here"
+user.instance_variable_replace(name: 'Steve', test: 'example') do
+  user.instance_variable_get('@name') #=> "Steve"
+  user.instance_variable_get('@test') #=> "example"
+end
+
+user.instance_variable_get('@name') #=> "Bob"
+user.instance_variable_get('@test') #=> nil
 ```
 
-Everything that we do with *instance* variables can be done with *class* variables as well!
+**Everything that we can do with *instance* variables can be done with *class* variables as well!**
 
 ```ruby
 example = User.class_variable(:example) #=> #<ClassVariable: User@@name>
@@ -128,6 +179,25 @@ User.class_variable_get('@@example') #=> "testing"
 ```
 
 
+## API
+
+[YARD Documentation](http://www.rubydoc.info/github/shuber/variables)
+
+* `Module#class_variable`
+* `Module#class_variable_fetch`
+* `Module#class_variable_replace`
+* `Object#instance_variable`
+* `Object#instance_variable_fetch`
+* `Object#instance_variable_replace`
+* `Variable#defined?`
+* `Variable#fetch`
+* `Variable#get`
+* `Variable#name`
+* `Variable#owner`
+* `Variable#replace`
+* `Variable#set`
+
+
 ## Testing
 
 ```

data/lib/variables.rb

@@ -1,6 +1,2 @@
 require 'variables/core_ext/module'
-require 'variables/core_ext/object'
 require 'variables/version'
-
-Module.send(:include, Variables::CoreExt::Module)
-Object.send(:include, Variables::CoreExt::Object)

data/lib/variables/core_ext/module.rb

@@ -1,4 +1,5 @@
 require 'variables/class_variable'
+require 'variables/core_ext/object'
 
 module Variables
   module CoreExt
@@ -8,12 +9,14 @@ module Variables
       end
 
       def class_variable_fetch(name, *args, &block)
-        class_variable(name).fetch(*args, &block)
+        fetch_variable(:class_variable, name, *args, &block)
       end
 
       def class_variable_replace(name, *args, &block)
-        class_variable(name).replace(*args, &block)
+        replace_variable(:class_variable, name, *args, &block)
       end
     end
   end
 end
+
+Module.send(:include, Variables::CoreExt::Module)

data/lib/variables/core_ext/object.rb

@@ -8,12 +8,38 @@ module Variables
       end
 
       def instance_variable_fetch(name, *args, &block)
-        instance_variable(name).fetch(*args, &block)
+        fetch_variable(:instance_variable, name, *args, &block)
       end
 
       def instance_variable_replace(name, *args, &block)
-        instance_variable(name).replace(*args, &block)
+        replace_variable(:instance_variable, name, *args, &block)
+      end
+
+      private
+
+      def fetch_variable(variable, name, *args, &block)
+        send(variable, name).fetch(*args, &block)
+      end
+
+      def replace_variable(variable, name, *args, &block)
+        if name.is_a?(Hash) && args.empty? && block_given?
+          replace_variable_proc(variable, name, &block).call
+        else
+          send(variable, name).replace(*args, &block)
+        end
+      end
+
+      def replace_variable_proc(variable, hash, &block)
+        hash.reduce(block) do |original, (name, value)|
+          proc do
+            send(variable, name).replace(value) do
+              original.call
+            end
+          end
+        end
       end
     end
   end
 end
+
+Object.send(:include, Variables::CoreExt::Object)

data/lib/variables/version.rb

@@ -1,3 +1,3 @@
 module Variables
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

data/spec/variables/core_ext/module_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path('../../../../lib/variables/core_ext/module', __FILE__)
 
 RSpec.describe Variables::CoreExt::Module do
-  subject { Class.new.extend(described_class) }
+  subject { Class.new }
 
   describe '#instance_variable' do
     it 'should initialize a new ClassVariable' do
@@ -33,5 +33,20 @@ RSpec.describe Variables::CoreExt::Module do
       value = subject.class_variable_replace(:test, :a, :b, &block)
       expect(value).to eq(:example)
     end
+
+    it 'should support a hash of variables to replace' do
+      subject.class_variable_replace(:one => 1, :two => 2) do
+        expect(subject.send(:class_variable_get, '@@one')).to eq(1)
+        expect(subject.send(:class_variable_get, '@@two')).to eq(2)
+      end
+
+      expect(subject.send(:class_variable_get, '@@one')).to be_nil
+      expect(subject.send(:class_variable_get, '@@two')).to be_nil
+    end
+
+    it 'should only support a hash of variables if a block is given' do
+      action = proc { subject.class_variable_replace(:one => 1, :two => 2) }
+      expect(action).to raise_error(ArgumentError)
+    end
   end
 end

data/spec/variables/core_ext/object_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path('../../../../lib/variables/core_ext/object', __FILE__)
 
 RSpec.describe Variables::CoreExt::Object do
-  subject { Object.new.extend(described_class) }
+  subject { Object.new }
 
   describe '#instance_variable' do
     it 'should initialize a new InstanceVariable' do
@@ -33,5 +33,20 @@ RSpec.describe Variables::CoreExt::Object do
       value = subject.instance_variable_replace(:test, :a, :b, &block)
       expect(value).to eq(:example)
     end
+
+    it 'should support a hash of variables to replace' do
+      subject.instance_variable_replace(:one => 1, :two => 2) do
+        expect(subject.instance_variable_get('@one')).to eq(1)
+        expect(subject.instance_variable_get('@two')).to eq(2)
+      end
+
+      expect(subject.instance_variable_get('@one')).to be_nil
+      expect(subject.instance_variable_get('@two')).to be_nil
+    end
+
+    it 'should only support a hash of variables if a block is given' do
+      action = proc { subject.instance_variable_replace(:one => 1, :two => 2) }
+      expect(action).to raise_error(ArgumentError)
+    end
   end
 end

data/variables.gemspec

@@ -2,7 +2,6 @@ require File.expand_path('../lib/variables/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.author           = 'Sean Huber'
-  s.description      = 'Ruby already has `Method` objects, why not `Variable` objects as well?'
   s.email            = 'github@shuber.io'
   s.extra_rdoc_files = %w(LICENSE)
   s.files            = `git ls-files`.split("\n")
@@ -11,7 +10,7 @@ Gem::Specification.new do |s|
   s.name             = 'variables'
   s.rdoc_options     = %w(--charset=UTF-8 --inline-source --line-numbers --main README.md)
   s.require_paths    = %w(lib)
-  s.summary          = '`Variable` objects for class and instance variables'
+  s.summary          = 'Ruby already has `Method` objects, why not `Variable` objects as well?'
   s.test_files       = `git ls-files -- spec/*`.split("\n")
   s.version          = Variables::VERSION
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: variables
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_class
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby already has `Method` objects, why not `Variable` objects as well?
+description: 
 email: github@shuber.io
 executables: []
 extensions: []
@@ -97,7 +97,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: "`Variable` objects for class and instance variables"
+summary: Ruby already has `Method` objects, why not `Variable` objects as well?
 test_files:
 - spec/spec_helper.rb
 - spec/variables/class_variable_spec.rb