kv_accessor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd61aa81ee2bcd6db26543b002c1916d366a1738
+  data.tar.gz: 2c2095c33a8d941b8c3d5325d9555e1bf5cfc455
+SHA512:
+  metadata.gz: 43edfb17fa1d2e34ade55e2a7b909ca6a8bfa7bcd2d788daff5c8d5f049227a85cdc72c1abea050476ea0add7b657e37ac1155653867f657479a30937fc932da
+  data.tar.gz: 6d2fa5e256730c6d25869499be0a30e1461b14dc0a96a0a810706912642e7d94c58dacee498e2db4b44d2dd12737eab0438431b294e26616309344acf1c8b734

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2016, Jeremiah McCann
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/kv_accessor/version.rb

@@ -0,0 +1,3 @@
+module KvAccessor
+  VERSION = '0.1.0'
+end

data/lib/kv_accessor.rb

@@ -0,0 +1,214 @@
+# Define reader and writer accessors for a Hash like instance method.
+#
+# Define reader and writer methods for a method returning a duck that quacks
+# like a Hash (`respond_to?(:[]`). The reader/writer can be named separately
+# from the ':[]' key via the alias_accessors argument (this allows for aliasing
+# of complex keys).
+#
+# A word of warning: '#inspect' is called on the ':[]' key,
+# '#to_s' is called on the 'key' name and the implimentation is via
+# 'class_eval'. '#to_s' is called on the passed 'method' name and the method
+# is called without regard to the receiver (eg. a Kernel method can be called
+# if no instance method overrides it).
+#
+# This is purely meant to be a DSL for creating value style objects. Take a look
+# at Struct, OpenStruct, and Virtus before choosing this.
+#
+# @example
+#   class MyCar
+#     attr_accessor :details
+#     extend KvAccessors
+#     kv_accessor :details, :make, year: 'model_year',
+#                 options: { 'leather' => 'blue' }
+#     kv_reader 'model'
+#
+#     def initialize(details = {})
+#       @details = details
+#     end
+#   end
+#
+#   c = MyCar.new(:make => 'Chevrolet', 'model' => 'Camaro',
+#                 'model_year' => 1967, 'submodel' => 'SS',
+#                 { 'leather' => 'blue' } => 2000.00)
+#   c.make
+#   #=> "Chevrolet"
+#   c.model
+#   #=> "Camaro"
+#   c.model = 'Corvette'
+#   #=> NoMethodError
+#   c.year
+#   #=> 1967
+#   c.year = 1968
+#   #=> 1968
+#   c.year
+#   #=> 1968
+#
+#   # using a complex key with alias. The key lookup would be:
+#   # details[{ 'leather' => 'blue' }]
+#   c.options
+#   #=> 2000.00
+#   c.options
+#   #=> 4000.00
+#
+#   c.submodel
+#   #=> NoMethodError
+#   c.details
+#   #=> { :make => "Chevrolet", "model" => "Camaro", "model_year" => 1967,
+#   #     "submodel" => "SS", { "leather" => "blue" } => 4000.00 }
+module KvAccessor
+  # Define reader and writter accessors for a Hash like instance method.
+  #
+  # Define reader and writter methods for each +keys+. Accessors named
+  # other than the key name can be defined via +aliased_accessors+.
+  # Calls to +name+ will call ':[]' on +method+ with either +key+ or the
+  # value described via +aliased_accessors+.
+  #
+  # See the overall {KvAccessors} docs for a better definition of what gets
+  # called on what.
+  #
+  # This is not guarded against any sort of user input. You have been warned.
+  #
+  # @example
+  #   class MyCar
+  #     attr_accessor :details
+  #     extend KvAccessors
+  #     kv_accessor :details, :make, 'model', year: :model_year
+  #
+  #     def initialize(details = {})
+  #       @details = details
+  #     end
+  #   end
+  #
+  #   c = MyCar.new(:make => 'Chevrolet', 'model' => 'Camaro',
+  #                 :model_year => 1967, 'submodel' => 'SS')
+  #   c.make
+  #   #=> "Chevrolet"
+  #   c.model
+  #   #=> "Camaro"
+  #   c.year
+  #   #=> 1966
+  #   c.year = 1967
+  #   #=> 1967
+  #   c.year
+  #   #=> 1967
+  #   c.submodel
+  #   #=> NoMethodError
+  #   c.details
+  #   #=> { :make => "Chevrolet", "model" => "Camaro", :model_year => 1968,
+  #   #     "submodel" => "SS"
+  def kv_accessor(method, *keys, **aliased_accessors)
+    kv_reader(method, *keys, **aliased_accessors)
+    kv_writer(method, *keys, **aliased_accessors)
+  end
+
+  # Define reader accessors for a Hash like instance method.
+  #
+  # Define reader accessor methods for each +keys+. Accessors named other than
+  # the key name can be defined via +aliased_accessors+. Calls to +name+ will
+  # call ':[]' on +method+ with either +key+ or the value described via
+  # +aliased_accessors+.
+  #
+  # See the overall {KvAccessors} docs for a better definition of what gets
+  # called on what.
+  #
+  # This is not guarded against any sort of user input. You have been warned.
+  #
+  # @example
+  #   class MyCar
+  #     attr_accessor :details
+  #     extend KvAccessors
+  #     kv_accessor :details, :make, 'model', year: :model_year
+  #
+  #     def initialize(details = {})
+  #       @details = details
+  #     end
+  #   end
+  #
+  #   c = MyCar.new(:make => 'Chevrolet', 'model' => 'Camaro',
+  #                 :model_year => 1967, 'submodel' => 'SS')
+  #   c.make #=> "Chevrolet"
+  #   c.model #=> "Camaro"
+  #   c.year #=> 1967
+  #   c.year = 1968
+  #   c.year #=> 1968
+  #   c.submodel #=> NoMethodError
+  #   c.details
+  #   #=> { :make => "Chevrolet", "model" => "Camaro", :model_year => 1968,
+  #         "submodel" => "SS" }
+  def kv_reader(method, *keys, **aliased_accessors)
+    accessors = Hash[keys.map { |v| [v, v] }].merge(aliased_accessors)
+    accessors.each do |name, key|
+      begin
+        line_no = __LINE__ + 1
+        str = <<-EOMETHODDEF
+          def #{name}
+            #{method}[#{key.inspect}]
+          end
+        EOMETHODDEF
+
+        module_eval(str, __FILE__, line_no)
+      # If it's not a class or module, it's an instance
+      rescue NoMethodError
+        instance_eval(str, __FILE__, line_no)
+      end
+    end
+  end
+
+  # Define writter accessors for a Hash like instance method.
+  #
+  # Define writter accessor methods for each +keys+. Accessors named other than
+  # the key name can be defined via +aliased_accessors+. Calls to +name+ will
+  # call ':[]' on +method+ with either +key+ or the value described via
+  # +aliased_accessors+.
+  #
+  # See the overall {KvAccessors} docs for a better definition of what gets
+  # called on what.
+  #
+  # This is not guarded against any sort of user input. You have been warned.
+  #
+  # @example
+  #   class MyCar
+  #     attr_accessor :details
+  #     extend KvAccessors
+  #     kv_writer :details, 'model', year: :model_year
+  #
+  #     def initialize(details = {})
+  #       @details = details
+  #     end
+  #   end
+  #
+  #   c = MyCar.new(:make => 'Chevrolet', 'model' => 'Camaro',
+  #                 :model_year => 1967, 'submodel' => 'SS')
+  #   c.make
+  #   #=> NoMethodError
+  #   c.model = 'Corvette'
+  #   #=> "Corevette"
+  #   #=> 1967
+  #   c.year = 1968
+  #   #=> 1968
+  #   c.year
+  #   #=> NoMethodError
+  #   c.submodel = 'RS'
+  #   #=> NoMethodError
+  #   c.details
+  #   #=> { :make => "Chevrolet", "model" => "Corvette", :model_year => 1968,
+  #   #     "submodel" => "SS"
+  def kv_writer(method, *keys, **aliased_accessors)
+    accessors = Hash[keys.map { |v| [v, v] }].merge(aliased_accessors)
+    accessors.each do |name, key|
+      begin
+        line_no = __LINE__ + 1
+        str = <<-EOMETHODDEF
+          def #{name}=(value)
+            #{method}[#{key.inspect}] = value
+          end
+        EOMETHODDEF
+
+        module_eval(str, __FILE__, line_no)
+      # If it's not a class or module, it's an instance
+      rescue NoMethodError
+        instance_eval(str, __FILE__, line_no)
+      end
+    end
+  end
+end

data/spec/lib/kv_accessor_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+RSpec.describe KvAccessor do
+  let(:default_details) do
+    {
+      :make => 'Chevrolet', 'model' => 'Camaro', :model => 'Key not string',
+      'submodel' => 'SS', 'model_year' => 1967, price: 40_000.00,
+      { 'leather' => 'blue' } => 2_000.00
+    }
+  end
+
+  let(:default_other) { { upc: '808' } }
+
+  let(:kv_class) do
+    Class.new do
+      attr_accessor :details, :other
+      extend KvAccessor
+
+      kv_accessor :details, :make, year: 'model_year',
+                  blue_interior: { 'leather' => 'blue' }
+      kv_reader :details, 'model', :price
+      kv_writer :details, 'color', :price
+
+      kv_accessor :other, :upc
+
+      def initialize(details, other)
+        self.details = details
+        self.other = other
+      end
+    end
+  end
+
+  # For the expect to change, the duping is somehow necessary
+  subject(:data_object) { kv_class.new(default_details.dup, default_other.dup) }
+
+  it 'responds to all the accessor names' do
+    expect(data_object).to respond_to(:make, :year, :blue_interior, :make=,
+                                      :year=, :blue_interior=, :model, :price,
+                                      :color=, :price=, :upc)
+  end
+
+  it 'does not respond to unspecified accessor names' do
+    expect(data_object).not_to respond_to(:submodel, :model=)
+  end
+
+  it 'has all of the corresponding reader attributes' do
+    expect(data_object).to have_attributes(
+      make: 'Chevrolet', model: 'Camaro', blue_interior: 2_000.00,
+      price: 40_000.00, year: 1967, upc: '808'
+    )
+  end
+
+  it 'updates only the explicit keys on attribute assignment' do
+    # There's some funky stuff going on with the ordering between `from()`,
+    # `change { }`, and `expect { }`. `change { }.from` doesn't seem to compare
+    # the objects first, before running the expect statement. I think it only
+    # saves the initial output, runs the expect statement, runs the change block
+    # again, and then finally compares the results. So any order dependent
+    # results need to be another copy.
+    expect {
+      data_object.make = 'Ford'
+      data_object.price = 41_000.00
+      data_object.year = 1968
+      data_object.blue_interior = 3_000.00
+      data_object.color = 'red'
+      data_object.upc = '809'
+    }.to change { data_object.details }.from(
+      default_details
+    ).to(
+      default_details.merge(
+        :make => 'Ford', :price => 41_000.00, 'model_year' => 1968,
+        'color' => 'red', { 'leather' => 'blue' } => 3_000.00,
+      )
+    ).and change { data_object.other }.from(
+      default_other
+    ).to(upc: '809')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'kv_accessor'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: kv_accessor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremiah McCann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Pretty much Forwardable for key-value objects
+email:
+- kv.accessor.gem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/kv_accessor.rb
+- lib/kv_accessor/version.rb
+- spec/lib/kv_accessor_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jmhmccr/kv_accessor
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Generate accessor methods for an indexed object
+test_files:
+- spec/lib/kv_accessor_spec.rb
+- spec/spec_helper.rb