rails-patterns 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0527dc116049d1579ba19deadf9ad643b0abf9b
-  data.tar.gz: 52f5f8cae780e21a3a91b7b82602d71814883a3c
+  metadata.gz: a0004234c0698b57bbf9960c6431427a1f548df9
+  data.tar.gz: 9891b7eba903e69d516153c5664b9cf0e04c7f90
 SHA512:
-  metadata.gz: 58005bd76bfb7d2c30d83025343765b201994e1b4161e0e7c04b37a54ed5e88a98180afde2d4c46f8e70e4dd51ad06c0733bd073d47a5647721d7dbda43f0b49
-  data.tar.gz: b461d4fa96a92acb04a56ccc202a41aa79cbdb2948a0c94f5a56ebc3bd228c277a5db17331c6e690a9bdade2b84fe4a6ae008e835c84556ede60b4a038f991b9
+  metadata.gz: 8aa0d32fc28cb5924dab59cc9a9d088e940cb7d11e19058f7d7bd5fdc25084554655ee48b9ce1e5938e21b5a70358b78a2d4aa0a98ee455b44d6502e6f2eb615
+  data.tar.gz: 3bcec212d6958aeed3e29ff72ffeca10d0dbe726b1376aa42585f171464f726ac36950db8b49c8a9bfc8eaad98c47458b48a4a01c613905f138759a89c243d61

data/Gemfile.lock

@@ -136,4 +136,4 @@ DEPENDENCIES
   virtus
 
 BUNDLED WITH
-   1.14.6
+   1.15.1

data/README.md

@@ -6,6 +6,7 @@ A collection of lightweight, standardized, rails-oriented patterns.
 - [Service - useful for handling processes involving multiple steps](#service)
 - [Collection - when in need to add a method that relates to the collection as whole](#collection)
 - [Form - when you need a place for callbacks, want to replace strong parameters or handle virtual/composite resources](#form)
+- [Calculation - when you need a place for calculating a simple value (numeric, array, hash) and/or cache it](#calculation)
 
 ## Installation
 
@@ -274,6 +275,75 @@ ReportConfigurationForm.new
 ReportConfigurationForm.new({ include_extra_data: true, dump_as_csv: true })
 ```
 
+## Calculation
+
+### When to use it
+
+Calculation objects provide a place to calculate simple values (i.e. numeric, arrays, hashes), especially when calculations require interacting with multiple classes, and thus do not fit into any particular one.
+Calculation objects also provide simple abstraction for caching their results.
+
+### Assumptions and rules
+
+* Calculations have to implement `#result` method that returns any value (result of calculation).
+* Calculations do provide `.set_cache_expiry_every` method, that allows defining caching period.
+* When `.set_cache_expiry_every` is not used, result is not being cached.
+* Calculations return result by calling any of following methods: `.calculate`, `.result_for` or `.result`.
+* First argument passed to calculation is accessible by `#subject` private method.
+* Arguments hash passed to calculation is accessible by `#options` private method.
+* Caching takes into account arguments passed when building cache key.
+* To build cache key, `#cache_key` of each argument value is used if possible.
+* By default `Rails.cache` is used as cache store.
+
+### Examples
+
+#### Declaration
+
+```ruby
+class AverageHotelDailyRevenue < Patterns::Calculation
+  set_cache_expiry_every 1.day
+
+  private
+
+  def result
+    reservations.sum(:price) / days_in_year
+  end
+
+  def reservations
+    Reservation.where(
+      date: (beginning_of_year..end_of_year),
+      hotel_id: subject.id
+    )
+  end
+
+  def days_in_year
+    end_of_year.yday
+  end
+
+  def year
+    options.fetch(:year, Date.current.year)
+  end
+
+  def beginning_of_year
+    Date.new(year).beginning_of_year
+  end
+
+  def end_of_year
+    Date.new(year).end_of_year
+  end
+end
+```
+
+#### Usage
+
+```ruby
+hotel = Hotel.find(123)
+AverageHotelDailyRevenue.result_for(hotel)
+AverageHotelDailyRevenue.result_for(hotel, year: 2015)
+
+TotalCurrentRevenue.calculate
+AverageDailyRevenue.result
+```
+
 ## 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.4.1
+0.5.0

data/lib/patterns/calculation.rb

@@ -0,0 +1,45 @@
+module Patterns
+  class Calculation
+    class_attribute :cache_expiry_every
+
+    def initialize(*args)
+      @options = args.extract_options!
+      @subject = args.first
+    end
+
+    def self.result(*args)
+      new(*args).cached_result
+    end
+
+    class << self
+      alias_method :result_for, :result
+      alias_method :calculate, :result
+    end
+
+    def self.set_cache_expiry_every(period)
+      self.cache_expiry_every = period
+    end
+
+    def cached_result
+      Rails.cache.fetch(cache_key, expires_in: cache_expiry_period, force: cache_expiry_period.blank?) do
+        result
+      end
+    end
+
+    private
+
+    attr_reader :subject, :options
+
+    def result
+      raise NotImplementedError
+    end
+
+    def cache_key
+      "#{self.class.name}_#{[subject, options].hash}"
+    end
+
+    def cache_expiry_period
+      self.class.cache_expiry_every
+    end
+  end
+end

data/lib/patterns/form.rb

@@ -49,6 +49,14 @@ module Patterns
       self
     end
 
+    def to_param
+      if resource.present? && resource.respond_to?(:to_param)
+        resource.to_param
+      else
+        nil
+      end
+    end
+
     def persisted?
       if resource.present? && resource.respond_to?(:persisted?)
         resource.persisted?
@@ -58,9 +66,7 @@ module Patterns
     end
 
     def model_name
-      @model_name ||= Struct.
-        new(:param_key).
-        new(param_key)
+      @model_name ||= OpenStruct.new(model_name_attributes)
     end
 
     def self.param_key(key = nil)
@@ -75,13 +81,24 @@ module Patterns
 
     attr_reader :resource, :form_owner
 
-    def param_key
-      param_key = self.class.param_key
-      param_key ||= resource.present? && resource.respond_to?(:model_name) && resource.model_name.param_key
-      raise NoParamKey if param_key.blank?
-      param_key
+    def model_name_attributes
+      if self.class.param_key.present?
+        {
+          param_key: self.class.param_key,
+          route_key: self.class.param_key.pluralize,
+          singular_route_key: self.class.param_key
+        }
+      elsif resource.present? && resource.respond_to?(:model_name)
+        {
+          param_key: resource.model_name.param_key,
+          route_key: resource.model_name.route_key,
+          singular_route_key: resource.model_name.singular_route_key
+        }
+      else
+        raise NoParamKey
+      end
     end
-
+    
     def build_original_attributes
       return {} if resource.nil?
       base_attributes = resource.respond_to?(:attributes) && resource.attributes.symbolize_keys

data/lib/rails-patterns.rb

@@ -2,4 +2,5 @@ require "patterns"
 require "patterns/query"
 require "patterns/service"
 require "patterns/collection"
+require "patterns/calculation"
 require "patterns/form"

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.4.1 ruby lib
+# stub: rails-patterns 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails-patterns".freeze
-  s.version = "0.4.1"
+  s.version = "0.5.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-05-09"
+  s.date = "2017-06-22"
   s.description = "A collection of lightweight, standardized, rails-oriented patterns.".freeze
   s.email = "b.kosmowski@selleo.com".freeze
   s.extra_rdoc_files = [
@@ -28,12 +28,14 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/patterns.rb",
+    "lib/patterns/calculation.rb",
     "lib/patterns/collection.rb",
     "lib/patterns/form.rb",
     "lib/patterns/query.rb",
     "lib/patterns/service.rb",
     "lib/rails-patterns.rb",
     "rails-patterns.gemspec",
+    "spec/patterns/calculation_spec.rb",
     "spec/patterns/collection_spec.rb",
     "spec/patterns/form_spec.rb",
     "spec/patterns/query_spec.rb",

data/spec/patterns/calculation_spec.rb

@@ -0,0 +1,163 @@
+RSpec.describe Patterns::Calculation do
+  before(:all) do
+    class Rails
+      def self.cache
+        @cache ||= ActiveSupport::Cache::MemoryStore.new
+      end
+    end
+  end
+
+  after(:all) do
+    Object.send(:remove_const, :Rails)
+  end
+
+  after do
+    Object.send(:remove_const, :CustomCalculation) if defined?(CustomCalculation)
+    Rails.cache.clear
+  end
+
+  describe ".result" do
+    it "returns a result of the calculation within a #result method" do
+      CustomCalculation = Class.new(Patterns::Calculation) do
+        private
+
+        def result
+          50
+        end
+      end
+
+      expect(CustomCalculation.result).to eq 50
+    end
+
+    it "#result, #result_for and #calculate are aliases" do
+      CustomCalculation = Class.new(Patterns::Calculation)
+
+      expect(CustomCalculation.method(:result)).to eq CustomCalculation.method(:result_for)
+      expect(CustomCalculation.method(:result)).to eq CustomCalculation.method(:calculate)
+    end
+
+    it "exposes the first argument as a subject" do
+      CustomCalculation = Class.new(Patterns::Calculation) do
+        private
+
+        def result
+          subject
+        end
+      end
+
+      expect(CustomCalculation.result('test')).to eq 'test'
+    end
+
+    it "exposes all keyword arguments using #options" do
+      CustomCalculation = Class.new(Patterns::Calculation) do
+        private
+
+        def result
+          [options[:arg_1], options[:arg_2]]
+        end
+      end
+
+      expect(CustomCalculation.result(nil, arg_1: 20, arg_2: 30)).to eq([20, 30])
+    end
+  end
+
+  describe "caching" do
+    it "caches result for 'set_cache_expiry_every' period" do
+      travel_to DateTime.new(2017, 1, 1, 12, 0) do
+        CustomCalculation = Class.new(Patterns::Calculation) do
+          set_cache_expiry_every 1.hour
+
+          class_attribute :counter
+          self.counter = 0
+
+          private
+
+          def result
+            self.class.counter += 1
+          end
+        end
+
+        expect(CustomCalculation.result).to eq 1
+        expect(CustomCalculation.result).to eq 1
+      end
+
+      travel_to DateTime.new(2017, 1, 1, 13, 1) do
+        expect(CustomCalculation.result).to eq 2
+        expect(CustomCalculation.result).to eq 2
+      end
+    end
+
+    it "caches result for every option passed" do
+      CustomCalculation = Class.new(Patterns::Calculation) do
+        set_cache_expiry_every 1.hour
+
+        class_attribute :counter
+        self.counter = 0
+
+        private
+
+        def result
+          self.class.counter += 1
+        end
+      end
+
+      expect(CustomCalculation.result(123)).to eq 1
+      expect(CustomCalculation.result(123)).to eq 1
+      expect(CustomCalculation.result(1024)).to eq 2
+      expect(CustomCalculation.result(1024)).to eq 2
+      expect(CustomCalculation.result(1024, arg: 1)).to eq 3
+      expect(CustomCalculation.result(1024, arg: 1)).to eq 3
+    end
+
+    it "caches result for every option passed dependant on the class" do
+      CustomCalculation = Class.new(Patterns::Calculation) do
+        set_cache_expiry_every 1.hour
+
+        class_attribute :counter
+        self.counter = 0
+
+        private
+
+        def result
+          self.class.counter += 1
+        end
+      end
+
+      DifferentCalculation = Class.new(Patterns::Calculation) do
+        set_cache_expiry_every 1.hour
+
+        class_attribute :counter
+        self.counter = 100
+
+        private
+
+        def result
+          self.class.counter += 1
+        end
+      end
+
+      expect(CustomCalculation.result(123)).to eq 1
+      expect(CustomCalculation.result(123)).to eq 1
+      expect(DifferentCalculation.result(123)).to eq 101
+      expect(DifferentCalculation.result(123)).to eq 101
+
+      Object.send(:remove_const, :DifferentCalculation)
+    end
+
+    it "does not cache result if 'set_cache_expiry_every' is not set" do
+      CustomCalculation = Class.new(Patterns::Calculation) do
+        class_attribute :counter
+        self.counter = 0
+
+        private
+
+        def result
+          self.class.counter += 1
+        end
+      end
+
+      expect(CustomCalculation.result).to eq 1
+      expect(CustomCalculation.result).to eq 2
+    end
+  end
+end

data/spec/patterns/form_spec.rb

@@ -316,7 +316,7 @@ RSpec.describe Patterns::Form do
   end
 
   describe "#to_model" do
-    it "retruns itself" do
+    it "returns itself" do
       CustomForm = Class.new(Patterns::Form)
 
       form = CustomForm.new(double)
@@ -345,86 +345,132 @@ RSpec.describe Patterns::Form do
     end
   end
 
-  describe "#model_name" do
-    describe "#param_key" do
-      context "resource exists" do
-        context "resource responds to #model_name" do
-          context "param_key is not defined" do
-            it "returns object responding to #param_key returning resource#param_key" do
-              CustomForm = Class.new(Patterns::Form)
-              resource = double(model_name: double(param_key: "resource_key"))
-
-              form = CustomForm.new(resource)
-              result = form.model_name
-
-              expect(result).to respond_to(:param_key)
-              expect(result.param_key).to eq "resource_key"
-            end
-          end
-
-          context "param_key is defined" do
-            it "returns param_key" do
-              CustomForm = Class.new(Patterns::Form) do
-                param_key "test_key"
-              end
-              resource = double(model_name: double(param_key: "resource_key"))
+  describe "#to_param" do
+    context "resource exists" do
+      context "resource responds to #to_param" do
+        it "returns resource#to_param" do
+          CustomForm = Class.new(Patterns::Form)
+          resource = double(to_param: 100)
 
-              form = CustomForm.new(resource)
-              result = form.model_name
+          form = CustomForm.new(resource)
 
-              expect(result.param_key).to eq "test_key"
-            end
-          end
+          expect(form.to_param).to eq 100
         end
+      end
+    end
+
+    context "resource does not exist" do
+      it "returns nil" do
+        CustomForm = Class.new(Patterns::Form)
 
-        context "resource does not respond to #model_name" do
-          context "param_key is not defined" do
-            it "raises NoParamKey" do
-              CustomForm = Class.new(Patterns::Form)
+        form = CustomForm.new
 
-              form = CustomForm.new(double)
+        expect(form.to_param).to eq nil
+      end
+    end
+  end
 
-              expect { form.model_name }.to raise_error(Patterns::Form::NoParamKey)
-            end
-          end
+  describe "#model_name" do
+    context "resource exists" do
+      context "resource responds to #model_name" do
+        context "param_key is not defined" do
+          it "returns object's model name param_key, route_key and singular_route_key" do
+            CustomForm = Class.new(Patterns::Form)
+            resource = double(model_name: double(
+              param_key: "resource_key",
+              route_key: "resource_keys",
+              singular_route_key: "resource_key"
+            ))
 
-          context "param_key is defined" do
-            it "returns param_key" do
-              CustomForm = Class.new(Patterns::Form) do
-                param_key "test_key"
-              end
+            form = CustomForm.new(resource)
+            result = form.model_name
 
-              form = CustomForm.new(double)
-              result = form.model_name
+            expect(result).to have_attributes(
+              param_key: "resource_key",
+              route_key: "resource_keys",
+              singular_route_key: "resource_key"
+            )
+          end
+        end
 
-              expect(result.param_key).to eq "test_key"
+        context "param_key is defined" do
+          it "returns param_key, route_key and singular_route_key derived from param key" do
+            CustomForm = Class.new(Patterns::Form) do
+              param_key "test_key"
             end
+            resource = double(model_name: double(
+              param_key: "resource_key",
+              route_key: "resource_keys",
+              singular_route_key: "resource_key"
+            ))
+
+            form = CustomForm.new(resource)
+            result = form.model_name
+
+            expect(result).to have_attributes(
+              param_key: "test_key",
+              route_key: "test_keys",
+              singular_route_key: "test_key"
+            )
           end
         end
       end
 
-      context "resource does not exist" do
+      context "resource does not respond to #model_name" do
         context "param_key is not defined" do
           it "raises NoParamKey" do
             CustomForm = Class.new(Patterns::Form)
 
-            form = CustomForm.new
+            form = CustomForm.new(double)
 
             expect { form.model_name }.to raise_error(Patterns::Form::NoParamKey)
           end
         end
 
         context "param_key is defined" do
-          it "returns param_key" do
+          it "returns param_key, route_key and singular_route_key derived from param key" do
             CustomForm = Class.new(Patterns::Form) do
               param_key "test_key"
             end
 
-            form = CustomForm.new
+            form = CustomForm.new(double)
             result = form.model_name
 
-            expect(result.param_key).to eq "test_key"
+            expect(result).to have_attributes(
+              param_key: "test_key",
+              route_key: "test_keys",
+              singular_route_key: "test_key"
+            )
+          end
+        end
+      end
+    end
+
+    context "resource does not exist" do
+      context "param_key is not defined" do
+        it "raises NoParamKey" do
+          CustomForm = Class.new(Patterns::Form)
+
+          form = CustomForm.new
+
+          expect { form.model_name }.to raise_error(Patterns::Form::NoParamKey)
+        end
+      end
+
+      context "param_key is defined" do
+        it "returns param_key, route_key and singular_route_key derived from param key" do
+          CustomForm = Class.new(Patterns::Form) do
+            param_key "test_key"
           end
+
+          form = CustomForm.new
+          result = form.model_name
+
+          expect(result).to have_attributes(
+            param_key: "test_key",
+            route_key: "test_keys",
+            singular_route_key: "test_key"
+          )
         end
       end
     end

data/spec/spec_helper.rb

@@ -17,10 +17,14 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-require "rails-patterns"
+require "active_support/all"
+require "active_support/testing/time_helpers"
 require "pry"
+require "rails-patterns"
 
 RSpec.configure do |config|
+  config.include ActiveSupport::Testing::TimeHelpers
+
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
   # assertions if you prefer.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-patterns
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Stevo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -111,12 +111,14 @@ files:
 - Rakefile
 - VERSION
 - lib/patterns.rb
+- lib/patterns/calculation.rb
 - lib/patterns/collection.rb
 - lib/patterns/form.rb
 - lib/patterns/query.rb
 - lib/patterns/service.rb
 - lib/rails-patterns.rb
 - rails-patterns.gemspec
+- spec/patterns/calculation_spec.rb
 - spec/patterns/collection_spec.rb
 - spec/patterns/form_spec.rb
 - spec/patterns/query_spec.rb