mini_object 0.0.2 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aa379aae7d9c42cfcfb360a0ddb6fda0fcecdaa
-  data.tar.gz: 320b678ed4208c284b00d89d8d9d78fa0de57ae3
+  metadata.gz: 2baad867ef2ce55721742c1931bc49e2d2048fcc
+  data.tar.gz: cd136dba6c44ea7a742e7ee7a99432ee18d77043
 SHA512:
-  metadata.gz: 1b0abff2dcdab9666d1c296e9072171c7b82dea205b469f8752a9dcf062688e9599153d508c0f1dbd61dff41b098e1806dae089d034f91983119b8a86989e03c
-  data.tar.gz: 6c2fc780b5cceb48245f03a8554f8cbce836e88f185ece9523ed353fbaf53ebbdfe0722546d1aa2dbd47e7185f711d61e662e00d75be73778ca4a14eb9ca3a09
+  metadata.gz: 91908461951fa69f42d323e4b6c12529406465e92184d40f4bc0bf54799ef55743919c278227117d74af433187430645c43686c63d0c9df251a60b53e36ce6b1
+  data.tar.gz: c0d0edfff3ae6dd9db5e1c05f4316d681a4e0310d606efcea03388b1a31ab8d429ec5badef612a1a3ca39628a6339b80824ac0225661b5b1fd05a9c6ddeb1235

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    mini_object (0.0.1)
+    mini_object (0.1.2)
+      forwarding_dsl (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -11,6 +12,7 @@ GEM
     coderay (1.1.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    forwarding_dsl (1.0.1)
     method_source (0.8.2)
     multi_json (1.10.1)
     pry (0.10.1)
@@ -45,5 +47,5 @@ DEPENDENCIES
   codeclimate-test-reporter
   mini_object!
   pry
-  rake
+  rake (~> 10.4)
   rspec

data/README.md

@@ -99,6 +99,40 @@ In the example, if `app.stores.redis`, the repository
 will inmediately see the new store.
 
 
+## IndexedList
+
+An enumerable of objects that makes it easy to create custom collections.
+It allows to find items by a custom key, similar to a Hash.
+When iterating through the items it only passes just the object, not the keys.
+Allows to define a build proc, so you can add new items with the `add_new` method.
+Plays well with `ForwardingDsl::Getsetter`:
+
+```ruby
+require 'forwarding_dsl'
+require 'mini_object'
+
+class User
+  include ForwardingDsl::Getsetter
+  getsetter :name
+  getsetter :surname
+end
+
+users = MiniObject::IndexedList.new.tap do |l|
+  l.key {|user| user.name }
+  l.build { User.new }
+end
+
+users.add_new do
+  name 'John'
+  surname 'Smith'
+end
+
+users['John'] # => #<User:0x007fd91e05deb8 @name="John", @surname="Smith">
+
+users.each {|user| puts "#{user.name} #{user.surname}" }
+# => John Smith
+```
+
 ## Contributing
 
 Do not forget to run the tests with:

data/lib/indexed_list.rb

@@ -0,0 +1,72 @@
+require 'forwarding_dsl'
+
+module MiniObject
+  class IndexedList
+    include Enumerable
+
+    def initialize
+      @store = {}
+    end
+
+    def key &block
+      @key_proc = block
+    end
+
+    def build &block
+      @build_proc = block
+    end
+
+    def << e
+      store[key_for(e)] = e
+    end
+
+    alias add <<
+
+    def add_new &block
+      e = build_new
+      ForwardingDsl.run e, &block
+      add e
+    end
+
+    def [] key
+      store.values.detect {|e| key_for(e) == key }
+    end
+
+    def each &block
+      store.values.each &block
+    end
+
+    def clear
+      store.clear
+    end
+
+    def merge other
+      new = dup
+
+      other.each do |v|
+        new << v
+      end
+
+      new
+    end
+
+    def initialize_dup(source)
+      @store = store.dup
+      super
+    end
+
+    private
+
+    def store
+      @store
+    end
+
+    def key_for e
+      @key_proc.call e
+    end
+
+    def build_new *args
+      @build_proc.call *args
+    end
+  end
+end

data/lib/mini_object.rb

@@ -10,4 +10,5 @@ module MiniObject
   autoload :ForwardingDSL, 'forwarding_dsl'
   autoload :RemarkableInspect, 'remarkable_inspect'
   autoload :Box, 'box'
+  autoload :IndexedList, 'indexed_list'
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module MiniObject
-  VERSION = "0.0.2"
+  VERSION = "0.1.2"
 end

data/mini_object.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "forwarding_dsl", "~> 1.0"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", '~> 10.4'
 end

data/spec/indexed_list_spec.rb

@@ -0,0 +1,100 @@
+require_relative 'spec_helper'
+
+RSpec.describe 'IndexedList' do
+  let(:subject_class) { MiniObject::IndexedList }
+
+  let(:subject_instance) do
+    subject_class.new.tap do |l|
+      l.key {|e| e.name }
+      l.build { OpenStruct.new }
+    end
+  end
+
+  subject { subject_instance }
+
+  it 'accumulates values with <<' do
+    value = double('value', name: 'Value 1')
+    subject << value
+    expect(subject['Value 1']).to be value
+  end
+
+  it 'accumulates values with add' do
+    value = double('value', name: 'Value 1')
+    subject.add value
+    expect(subject['Value 1']).to be value
+  end
+
+  it 'adds new values' do
+    value = subject.add_new do |e|
+      e.name = 'Value 1'
+    end
+
+    expect(subject['Value 1']).to be value
+  end
+
+  it 'iterates through values' do
+    has_run = false
+
+    value = subject.add_new do |e|
+      e.name = 'Value 1'
+    end
+
+    subject.each do |e|
+      has_run = true
+      expect(e).to be value
+    end
+  end
+
+  it 'converts to array' do
+    value = subject.add_new do |e|
+      e.name = 'Value 1'
+    end
+
+    expect(subject.to_a).to eq [value]
+  end
+
+  it 'clears' do
+    value = subject.add_new do |e|
+      e.name = 'Value 1'
+    end
+
+    subject.clear
+
+    expect(subject.to_a).to eq []
+  end
+
+  it 'merges' do
+    subject_2 = subject_class.new.tap do |l|
+      l.key {|e| e.name }
+      l.build { OpenStruct.new }
+    end
+
+    value_1 = subject.add_new do |v|
+      v.name = 1
+    end
+
+    value_2 = subject_2.add_new do |v|
+      v.name = 2
+    end
+
+    expect(subject.merge(subject_2).to_a).to eq [value_1, value_2]
+  end
+
+  it 'merges without altering the original' do
+    subject_2 = subject_class.new.tap do |l|
+      l.key {|e| e.name }
+      l.build { OpenStruct.new }
+    end
+
+    value_1 = subject.add_new do |v|
+      v.name = 1
+    end
+
+    value_2 = subject_2.add_new do |v|
+      v.name = 2
+    end
+
+    subject.merge(subject_2).to_a
+    expect(subject.to_a).to eq [value_1]
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mini_object
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.2
 platform: ruby
 authors:
 - Manuel Morales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
+date: 2015-06-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: forwarding_dsl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +72,7 @@ files:
 - README.md
 - Rakefile
 - lib/box.rb
+- lib/indexed_list.rb
 - lib/injectable.rb
 - lib/inline.rb
 - lib/lazy.rb
@@ -68,6 +83,7 @@ files:
 - mini_object-0.0.1.gem
 - mini_object.gemspec
 - spec/box_spec.rb
+- spec/indexed_list_spec.rb
 - spec/injectable_spec.rb
 - spec/inline_spec.rb
 - spec/lazy_spec.rb
@@ -101,6 +117,7 @@ specification_version: 4
 summary: Easier working with instances instead of classes and dependency injection
 test_files:
 - spec/box_spec.rb
+- spec/indexed_list_spec.rb
 - spec/injectable_spec.rb
 - spec/inline_spec.rb
 - spec/lazy_spec.rb