rails-patterns 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e92ba62b5937443b24c3399655e678b6deb2d273
-  data.tar.gz: '0973bdde4d88392f6cd3a2a8a08fe77a3cf1f007'
+  metadata.gz: 2318f3f2a2753ab5159fa535d0245110eca7133c
+  data.tar.gz: 6031c700f903e0a62ef3a9951f83932d590a887c
 SHA512:
-  metadata.gz: 8fd3b635495855827654b7b818ee074ac562a919e6610c470cce226afcdf0dfe9944ff5867858d945054732c503babd63588d3775c517f9270846901f56eeb00
-  data.tar.gz: '068e1a602e2e1c591853e1491cfb1bf13e48f56dbaff45ee0db72417be176036939073769212d983da7b098ca5ecccd6935b0812fd83f761ee7db9cd176488e0'
+  metadata.gz: 4eabca7c85d89675918642a3f07c72effce0fccb4d709cc4d13c986cb549b9216dc7913cf2303ca464efa69c157b168f3d71301dd0422af13c738fce639e47e4
+  data.tar.gz: b3d706d159d0abedab70f3aadb818c1b977463aa37e683f8a5bd2b3d139a187e3ac72d4b18b98def990ff739ce5d5b224b9de2f03c27e5585283f4213d4479df

data/Gemfile

@@ -11,3 +11,7 @@ group :development do
   gem "bundler", "~> 1.0"
   gem "juwelier", "~> 2.1.0"
 end
+
+group "test" do
+  gem "pry-rails"
+end

data/Gemfile.lock

@@ -15,6 +15,7 @@ GEM
     addressable (2.4.0)
     arel (7.1.4)
     builder (3.2.3)
+    coderay (1.1.1)
     concurrent-ruby (1.0.5)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
@@ -43,6 +44,7 @@ GEM
       rdoc
       semver
     jwt (1.5.6)
+    method_source (0.8.2)
     mime-types (2.99.3)
     mini_portile2 (2.1.0)
     minitest (5.10.1)
@@ -57,6 +59,12 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-rails (0.3.6)
+      pry (>= 0.10.4)
     rack (2.0.1)
     rake (12.0.0)
     rdoc (5.1.0)
@@ -74,6 +82,7 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     semver (1.0.1)
+    slop (3.6.0)
     thread_safe (0.3.6)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
@@ -85,6 +94,7 @@ DEPENDENCIES
   activerecord (>= 4.2.6)
   bundler (~> 1.0)
   juwelier (~> 2.1.0)
+  pry-rails
   rspec
 
 BUNDLED WITH

data/README.md

@@ -117,6 +117,59 @@ end
   user_activation.result # <User id: 5803143, email: "tony@patterns.dev ...
 ```
 
+## Collection
+
+### When to use it
+
+One should consider using collection pattern when in need to add a method that relates to the collection a whole.
+Popular example for such situation is for paginated collections, where for instance `#current_page` getter makes sense only in collection context.
+Also collections can be used as a container for mapping or grouping logic (especially if the mapping is not 1-1 in terms of size).
+Collection might also act as a replacement for models not inheriting from ActiveRecord::Base (e.g. `StatusesCollection`, `ColorsCollection` etc.).
+What is more, collections can be used if we need to encapsulate "flagging" logic - for instance if we need to render a separator element between collection elements based on some specific logic, we can move this logic from view layer to collection and yield an additional flag to control rendering in view.
+
+### Assumptions and rules
+
+* Collections include `Enumerable`
+* Collections can be initialized using `.new`, `.from` and `.for` (aliases)
+* Collections have to implement `#collection` method that returns object responding to `#each`
+* Collections provide access to consecutive keyword arguments using `#options` hash
+* Collections provide access to first argument using `#subject`
+
+### Examples
+
+#### Declaration
+
+```ruby
+class ColorsCollection < Patterns::Collection
+  AVAILABLE_COLORS = { red: "#FF0000", green: "#00FF00", blue: "#0000FF" }
+
+  private
+
+  def collection
+    AVAILABLE_COLORS
+  end
+end
+
+class CustomerEventsByTypeCollection < Patterns::Collection
+  private
+
+  def collection
+    subject.
+    events.
+    group_by(&:type).
+    transform_values{ |event| event.public_send(options.fetch(:label_method, "description")) }
+  end
+end
+```
+
+#### Usage
+
+```ruby
+ColorsCollection.new
+CustomerEventsCollection.for(customer)
+CustomerEventsCollection.for(customer, label_method: "name")
+```
+
 ## Further reading
 
 * [7 ways to decompose fat active record models](http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/)

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/patterns/collection.rb

@@ -0,0 +1,29 @@
+module Patterns
+  class Collection
+    include Enumerable
+
+    def initialize(*args)
+      @options = args.extract_options!
+      @subject = args.first
+    end
+
+    def each
+      collection.each do |*args|
+        yield(*args)
+      end
+    end
+
+    class << self
+      alias from new
+      alias for new
+    end
+
+    private
+
+    attr_reader :options, :subject
+
+    def collection
+      raise NotImplementedError, "#collection not implemented"
+    end
+  end
+end

data/lib/rails-patterns.rb

@@ -1,3 +1,4 @@
 require "patterns"
 require "patterns/query"
 require "patterns/service"
+require "patterns/collection"

data/rails-patterns.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rails-patterns 0.2.0 ruby lib
+# stub: rails-patterns 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails-patterns".freeze
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Stevo".freeze]
-  s.date = "2017-04-13"
+  s.date = "2017-04-19"
   s.description = "A collection of lightweight, standardized, rails-oriented patterns.".freeze
   s.email = "b.kosmowski@selleo.com".freeze
   s.extra_rdoc_files = [
@@ -28,10 +28,12 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/patterns.rb",
+    "lib/patterns/collection.rb",
     "lib/patterns/query.rb",
     "lib/patterns/service.rb",
     "lib/rails-patterns.rb",
     "rails-patterns.gemspec",
+    "spec/patterns/collection_spec.rb",
     "spec/patterns/query_spec.rb",
     "spec/patterns/service_spec.rb",
     "spec/spec_helper.rb"

data/spec/patterns/collection_spec.rb

@@ -0,0 +1,141 @@
+RSpec.describe Patterns::Collection do
+  after { Object.send(:remove_const, :CustomCollection) if defined?(CustomCollection) }
+
+  it "includes Enumerable" do
+    CustomCollection = Class.new(Patterns::Collection)
+
+    expect(CustomCollection).to be < Enumerable
+  end
+
+  describe ".new" do
+    it "exposes all keyword arguments using #options by default" do
+      CustomCollection = Class.new(Patterns::Collection) do
+        private
+
+        def collection
+          [options[:arg_1], options[:arg_2]]
+        end
+      end
+
+      collection = CustomCollection.new(arg_1: 20, arg_2: 30)
+
+      expect { |b| collection.each(&b) }.to yield_successive_args(20, 30)
+    end
+
+    it "exposes first parameter using #subject by default" do
+      CustomCollection = Class.new(Patterns::Collection) do
+        private
+
+        def collection
+          subject
+        end
+      end
+
+      collection = CustomCollection.new([1, 2, 4, 8])
+
+      expect { |b| collection.each(&b) }.to yield_successive_args(1, 2, 4, 8)
+    end
+  end
+
+  describe ".from" do
+    it "returns collection instance" do
+      CustomCollection = Class.new(Patterns::Collection) do
+      end
+
+      collection = CustomCollection.from
+
+      expect(collection).to be_a_kind_of(CustomCollection)
+    end
+
+    it "exposes all keyword arguments using #options by default" do
+      CustomCollection = Class.new(Patterns::Collection) do
+        private
+
+        def collection
+          [options[:arg_1], options[:arg_2]]
+        end
+      end
+
+      collection = CustomCollection.from(arg_1: 20, arg_2: 30)
+
+      expect { |b| collection.each(&b) }.to yield_successive_args(20, 30)
+    end
+
+    it "exposes first parameter using #subject by default" do
+      CustomCollection = Class.new(Patterns::Collection) do
+        private
+
+        def collection
+          subject
+        end
+      end
+
+      collection = CustomCollection.from([1, 2, 4, 8])
+
+      expect { |b| collection.each(&b) }.to yield_successive_args(1, 2, 4, 8)
+    end
+  end
+
+  describe ".for" do
+    it "returns collection instance" do
+      CustomCollection = Class.new(Patterns::Collection) do
+      end
+
+      collection = CustomCollection.for
+
+      expect(collection).to be_a_kind_of(CustomCollection)
+    end
+
+    it "exposes all keyword arguments using #options by default" do
+      CustomCollection = Class.new(Patterns::Collection) do
+        private
+
+        def collection
+          [options[:arg_1], options[:arg_2]]
+        end
+      end
+
+      collection = CustomCollection.for(arg_1: 20, arg_2: 30)
+
+      expect { |b| collection.each(&b) }.to yield_successive_args(20, 30)
+    end
+
+    it "exposes first parameter using #subject by default" do
+      CustomCollection = Class.new(Patterns::Collection) do
+        private
+
+        def collection
+          subject
+        end
+      end
+
+      collection = CustomCollection.for([1, 2, 4, 8])
+
+      expect { |b| collection.each(&b) }.to yield_successive_args(1, 2, 4, 8)
+    end
+  end
+
+  describe "#each" do
+    it "requires #collection method being implemented" do
+      CustomCollection = Class.new(Patterns::Collection)
+
+      collection = CustomCollection.new
+
+      expect { collection.each }.to raise_error(NotImplementedError, "#collection not implemented")
+    end
+
+    it "performs #each on result of #collection" do
+      CustomCollection = Class.new(Patterns::Collection) do
+        private
+
+        def collection
+          [[1, "a"], [2, "b"], [3, "c"]]
+        end
+      end
+
+      collection = CustomCollection.new
+
+      expect { |b| collection.each(&b) }.to yield_successive_args([1, "a"], [2, "b"], [3, "c"])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -18,6 +18,7 @@
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
 require "rails-patterns"
+require "pry"
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-patterns
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stevo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -83,10 +83,12 @@ files:
 - Rakefile
 - VERSION
 - lib/patterns.rb
+- lib/patterns/collection.rb
 - lib/patterns/query.rb
 - lib/patterns/service.rb
 - lib/rails-patterns.rb
 - rails-patterns.gemspec
+- spec/patterns/collection_spec.rb
 - spec/patterns/query_spec.rb
 - spec/patterns/service_spec.rb
 - spec/spec_helper.rb