memory_record 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38453335376c705928d3272ad78e3803060f009c
-  data.tar.gz: 629b27607427d553237b8ad44b8d78ff55c21428
+  metadata.gz: 8c9cd8f7e037fbdb335febc08e26283d0323f704
+  data.tar.gz: 0a3eaf7f098d120c2f4c6ce912a2856bd6948462
 SHA512:
-  metadata.gz: 9e333eb93e434d2cb83dac1909366daebbefd8890fb8fde55dc2cf859f913b4cc83b13ea836755271d87b56c83d7b843399ce86d9b93aa489e7ecb5ddebfbb15
-  data.tar.gz: e0f422196c47fc513dcf4bee670c1aca3d41706f30ef76baf7f617b0a959f6cfa38aa60b213fc92d98643defd4c8700d32d492ae4d6faf7d676600641504999f
+  metadata.gz: 4885b1819bb3cfdc97ee1acdeee43d4e6ceaf44e21d55c79d67054a52d7954db39539cd09f30d8f55d7a4271d9e932b27b095a54c52bc807759c4dd24789a5ca
+  data.tar.gz: a0bb34531ba701cf5a36def1d27d441169987299d64419031ac81dc362e218e2ef81623cdb4a9299de29ff0edb5aa423ff8c8fe404a42ecdfeada027809a4403

data/.travis.yml

@@ -1,3 +1 @@
 language: ruby
-rvm:
-  - 2.2.3

data/README.org

@@ -28,7 +28,7 @@ class Language
     {key: :lisp, author: "John McCarthy"      },
     {key: :c,    author: "Dennis Ritchie"     },
     {key: :ruby, author: "Yukihiro Matsumoto" },
-  ], attr_reader_auto: true
+  ]
 
   def mr_author
     "Mr. #{author}"
@@ -53,7 +53,7 @@ class Foo
     {code: 1, key: :a, name: "A"},
     {code: 2, key: :b, name: "B"},
     {code: 3, key: :c, name: "C"},
-  ], attr_reader: :name
+  ]
 end
 
 Foo.collect(&:code) # => [1, 2, 3]
@@ -93,18 +93,6 @@ object.key  # => :a
 object.code # => 1
 #+END_SRC
 
-*** =attr_reader= option
-
-    The attribute value can be referenced with =@attributes[:xxx]=, but it is troublesome to refer frequently, so it is methodized with =attr_reader: xxx=.
-
-*** =attr_reader_auto= option
-
-    Automatically all attributes =attr_reader=
-
-*** What if I do not want you to feel free to access the attributes of a record?
-
-    =attr_reader= with no method definition and reference =object.attributes[:xxx]=
-
 *** How do I add a method to an instance?
 
     For that, I am creating a new class so I need to define it normally
@@ -115,7 +103,7 @@ object.code # => 1
 
 *** =to_s= method is defined?
 
-    = Alias of =name=, =to_s= is defined.
+    Alias of =name=, =to_s= is defined.
 
 *** If there is no key, use fetch to get an error
 

data/examples/{0110_basic.rb → 0100_basic.rb}

@@ -7,7 +7,7 @@ class Language
     {key: :lisp, author: "John McCarthy"      },
     {key: :c,    author: "Dennis Ritchie"     },
     {key: :ruby, author: "Yukihiro Matsumoto" },
-  ], attr_reader_auto: true
+  ]
 
   def mr_author
     "Mr. #{author}"

data/examples/{0130_for_legacy_code.rb → 0110_for_legacy_code.rb}

@@ -7,8 +7,8 @@ class Foo
     {code: 1, key: :a, name: 'A'},
     {code: 2, key: :b, name: 'B'},
     {code: 3, key: :c, name: 'C'},
-  ], :attr_reader => :name
+  ]
 end
 
-Foo[2].name                     # => 'B'
-Foo[:b].name                    # => 'B'
+Foo[2].name                     # => "B"
+Foo[:b].name                    # => "B"

data/examples/{0160_practice.rb → 0140_practice.rb}

@@ -6,20 +6,20 @@ class Direction
   memory_record [
     {key: :left,  name: '←', vector: [-1,  0]},
     {key: :right, name: '→', vector: [ 1,  0]},
-  ], attr_reader_auto: true
+  ]
 
   def long_name
-    '#{name}方向'
+    "#{name}方向"
   end
 end
 
-Direction.collect(&:name)       # => ['←', '→']
+Direction.collect(&:name)       # => ["←", "→"]
 Direction.keys                  # => [:left, :right]
 
 Direction[:right].key           # => :right
 Direction[:right].code          # => 1
 Direction[:right].vector        # => [1, 0]
-Direction[:right].long_name     # => '→方向'
+Direction[:right].long_name     # => "→方向"
 
 Direction[1].key                # => :right
 

data/examples/{0170_reset.rb → 0150_reset.rb}

@@ -3,19 +3,19 @@ require 'memory_record'
 
 class C
   include MemoryRecord
-  memory_record [{key: :a}], attr_reader: :name
+  memory_record [{key: :a}]
 end
 
 C.keys                          # => [:a]
 
 # memory_record では更新できない
 class C
-  memory_record [{key: :b}], attr_reader: :name
+  memory_record [{key: :b}]
 end
 
 C.keys                          # => [:a]
 
-# memory_record_list_set を使うこと
-C.memory_record_list_set [{key: :c}]
+# memory_record_reset を使うこと
+C.memory_record_reset [{key: :c}]
 
 C.keys                          # => [:c]

data/examples/{0180_key_is_anything_ok.rb → 0160_key_is_anything_ok.rb}

@@ -5,7 +5,7 @@ class Foo
   include MemoryRecord
   memory_record [
     {key: '↑', name: '上'},
-  ], attr_reader: :name
+  ]
 end
 
-Foo['↑'].name                  # => '上'
+Foo['↑'].name                  # => "上"

data/examples/{0190_tips_on_handling_boolean_type.rb → 0170_tips_on_handling_boolean_type.rb}

@@ -6,9 +6,9 @@ class Foo
   memory_record [
     {key: 'true',  name: '有効'},
     {key: 'false', name: '無効'},
-  ], attr_reader: :name
+  ]
 end
 
 flag = true
 
-Foo[flag.to_s].name             # => '有効'
+Foo[flag.to_s].name             # => "有効"

data/examples/{0200_freeze_makes_it_impossible_to_memorize.rb → 0180_freeze_makes_it_impossible_to_memorize.rb}

@@ -1,4 +1,4 @@
-# freeze してしまうとこれらのメモ化ができなくなる
+# If you freeze it will not be able to make these memos
 
 $LOAD_PATH.unshift '../lib'
 require 'memory_record'
@@ -13,7 +13,7 @@ class C2
   include MemoryRecord
   memory_record [
     {model: C},
-  ], attr_reader_auto: true
+  ]
 
   def x
     @x ||= 'OK'

data/examples/{0210_super_usable.rb → 0190_super_usable.rb}

@@ -5,7 +5,7 @@ class Foo
   include MemoryRecord
   memory_record [
     {a: 10},
-  ], attr_reader: :a
+  ]
 
   def a
     super * 2

data/examples/{0230_validation.rb → 0200_validation.rb}

@@ -6,7 +6,7 @@ class Foo
   memory_record [
     {name: 'alice'},
     {name: 'bob'},
-  ], attr_reader_auto: true
+  ]
 end
 
 require 'active_model'

data/examples/{0250_when_key_like_numeric.rb → 0220_when_key_like_numeric.rb}

@@ -6,7 +6,7 @@ class Foo
   memory_record [
     {key: '01', name: '→'},
     {key: '02', name: '←'},
-  ], attr_reader: :name
+  ]
 end
 
 Foo['01'] # => #<Foo:0x007fac2c35db28 @attributes={:key=>:'01', :name=>'→', :code=>0}>

data/examples/{0260_with_use_activerecord_enum.rb → 0230_with_use_activerecord_enum.rb}

@@ -16,9 +16,9 @@ end
 class GenderInfo
   include MemoryRecord
   memory_record [
-    {key: :male,   name: 'otoko'},
-    {key: :female, name: 'onna'},
-  ], attr_reader: :name
+    {key: :male,   name: '♂'},
+    {key: :female, name: '♀'},
+  ]
 end
 
 class User < ActiveRecord::Base
@@ -30,4 +30,4 @@ class User < ActiveRecord::Base
 end
 
 user = User.create!(gender_key: :male)
-user.gender_info.name           # => "otoko"
+user.gender_info.name           # => "♂"

data/lib/memory_record/memory_record.rb

@@ -9,30 +9,64 @@ module MemoryRecord
   extend ActiveSupport::Concern
 
   class_methods do
-    def memory_record(list, **options, &block)
+    # Example
+    #
+    #   memory_record [
+    #     {id: 1, name: "alice"},
+    #     {id: 2, name: "bob"  },
+    #   ], attr_reader: false
+    #
+    # or
+    #
+    #   memory_record(attr_reader: false) do
+    #     [
+    #       {id: 1, name: "alice"},
+    #       {id: 2, name: "bob"  },
+    #     ]
+    #   end
+    #
+    def memory_record(records = nil, **options, &block)
       return if memory_record_defined?
 
+      if block
+        options = records || {}
+        records = block.call
+      end
+
       extend ActiveModel::Translation
       extend Enumerable
       include ::MemoryRecord::SingletonMethods
 
-      class_attribute :memory_record_configuration
-      self.memory_record_configuration = {
-        attr_reader: [],
+      class_attribute :memory_record_options
+      self.memory_record_options = {
+        attr_reader: true,
       }.merge(options)
 
       if block_given?
-        yield memory_record_configuration
+        yield memory_record_options
       end
 
-      if memory_record_configuration[:attr_reader_auto]
-        _attr_reader = list.inject([]) { |a, e| a | e.keys.collect(&:to_sym) }
-      else
-        _attr_reader = memory_record_configuration[:attr_reader]
+      attr_reader_args = []
+      all_keys = records.inject([]) { |a, e| a | e.keys.collect(&:to_sym) }
+      case v = memory_record_options[:attr_reader]
+      when true
+        attr_reader_args = all_keys
+      when Hash
+        if v[:only]
+          all_keys &= Array(v[:only])
+        elsif v[:except]
+          all_keys -= Array(v[:except])
+        end
+        attr_reader_args = all_keys
+      when Array
+        attr_reader_args = v
+      when Symbol, String
+        attr_reader_args = [v]
       end
 
+      # Define it to an ancestor so that super method can be used.
       include Module.new.tap { |m|
-        ([:key, :code] + Array.wrap(_attr_reader)).uniq.each do |key|
+        ([:key, :code] + attr_reader_args).uniq.each do |key|
           m.class_eval do
             define_method(key) { @attributes[key.to_sym] }
           end
@@ -49,7 +83,7 @@ module MemoryRecord
         end
       }
 
-      memory_record_list_set(list)
+      memory_record_reset(records)
     end
 
     def memory_record_defined?
@@ -64,7 +98,10 @@ module MemoryRecord
       end
 
       def lookup(key)
-        return key if key.kind_of? self
+        if key.kind_of? self
+          return key
+        end
+
         case key
         when Symbol, String
           @values_hash[:key][key.to_sym]
@@ -75,7 +112,10 @@ module MemoryRecord
       alias [] lookup
 
       def fetch(key, default = nil, &block)
-        raise ArgumentError if block_given? && default
+        if block_given? && default
+          raise ArgumentError
+        end
+
         v = lookup(key)
         unless v
           case
@@ -112,18 +152,20 @@ module MemoryRecord
 
       attr_reader :values
 
-      def memory_record_list_set(list)
+      def memory_record_reset(records)
         @keys = nil
         @codes = nil
-        @values = list.collect.with_index {|e, i| new(_attributes_normalize(e, i)) }.freeze
+        @values = records.collect.with_index { |e, i|
+          new(_attributes_normalize(e, i))
+        }.freeze
         @values_hash = {}
         [:code, :key].each do |pk|
           @values_hash[pk] = @values.inject({}) do |a, e|
             a.merge(e.send(pk) => e) do |key, a, b|
               raise ArgumentError, [
                 "#{name}##{pk} #{key.inspect} is duplicate",
-                "Existing:  #{a.attributes.inspect}",
-                "Collision: #{b.attributes.inspect}",
+                "Existing: #{a.attributes.inspect}",
+                "Conflict: #{b.attributes.inspect}",
               ].join("\n")
             end
           end

data/lib/memory_record/version.rb

@@ -1,3 +1,3 @@
 module MemoryRecord
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/memory_record_spec.rb

@@ -20,7 +20,7 @@ RSpec.describe MemoryRecord do
   def __define(table)
     Class.new {
       include MemoryRecord
-      memory_record table, attr_reader_auto: true
+      memory_record table, attr_reader: true
     }
   end
 
@@ -82,7 +82,7 @@ RSpec.describe MemoryRecord do
   context 'Re-set' do
     before do
       @model = __define [{key: :a}]
-      @model.memory_record_list_set [{key: :b}, {key: :c}]
+      @model.memory_record_reset [{key: :b}, {key: :c}]
     end
     it 'changed' do
       assert_equal [:b, :c], @model.keys
@@ -132,13 +132,13 @@ RSpec.describe MemoryRecord do
     end
   end
 
-  describe 'attr_reader_auto' do
+  describe 'attr_reader' do
     class Model3
       include MemoryRecord
       memory_record [
         {a: 1},
         {b: 2},
-      ], attr_reader_auto: true
+      ]
     end
 
     it do
@@ -149,8 +149,8 @@ RSpec.describe MemoryRecord do
 
   describe 'Do not duplicate key and code' do
     it do
-      expect { Model.memory_record_list_set([{key: :a}, {key: :a}]) }.to raise_error(ArgumentError)
-      expect { Model.memory_record_list_set([{code: 0}, {code: 0}]) }.to raise_error(ArgumentError)
+      expect { Model.memory_record_reset([{key: :a}, {key: :a}]) }.to raise_error(ArgumentError)
+      expect { Model.memory_record_reset([{code: 0}, {code: 0}]) }.to raise_error(ArgumentError)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory_record
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - akicho8
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,21 +94,20 @@ files:
 - LICENSE.txt
 - README.org
 - Rakefile
-- examples/0110_basic.rb
-- examples/0120_attr_reader_auto_option.rb
-- examples/0130_for_legacy_code.rb
-- examples/0140_key_join_underscore_if_array.rb
-- examples/0150_behavior_like_hash.rb
-- examples/0160_practice.rb
-- examples/0170_reset.rb
-- examples/0180_key_is_anything_ok.rb
-- examples/0190_tips_on_handling_boolean_type.rb
-- examples/0200_freeze_makes_it_impossible_to_memorize.rb
-- examples/0210_super_usable.rb
-- examples/0230_validation.rb
-- examples/0240_key_duplicate.rb
-- examples/0250_when_key_like_numeric.rb
-- examples/0260_with_use_activerecord_enum.rb
+- examples/0100_basic.rb
+- examples/0110_for_legacy_code.rb
+- examples/0120_key_join_underscore_if_array.rb
+- examples/0130_behavior_like_hash.rb
+- examples/0140_practice.rb
+- examples/0150_reset.rb
+- examples/0160_key_is_anything_ok.rb
+- examples/0170_tips_on_handling_boolean_type.rb
+- examples/0180_freeze_makes_it_impossible_to_memorize.rb
+- examples/0190_super_usable.rb
+- examples/0200_validation.rb
+- examples/0210_key_duplicate.rb
+- examples/0220_when_key_like_numeric.rb
+- examples/0230_with_use_activerecord_enum.rb
 - lib/memory_record.rb
 - lib/memory_record/memory_record.rb
 - lib/memory_record/version.rb

data/examples/0120_attr_reader_auto_option.rb

@@ -1,14 +0,0 @@
-$LOAD_PATH.unshift '../lib'
-require 'memory_record'
-
-model = Class.new do
-  include MemoryRecord
-  memory_record [
-    {a: 1},
-    {b: 2},
-  ], attr_reader_auto: true
-end
-
-model.first.name                # => nil
-model.first.a                   # => 1
-model.first.b                   # => nil