rails-patterns 0.4.0 → 0.8.0

data/Rakefile

@@ -21,6 +21,7 @@ Juwelier::Tasks.new do |gem|
   gem.description = "A collection of lightweight, standardized, rails-oriented patterns."
   gem.email = "b.kosmowski@selleo.com"
   gem.authors = ["Stevo"]
+  gem.required_ruby_version = ">= 2.5.0"
 
   # dependencies defined in Gemfile
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.8.0

data/lib/patterns/calculation.rb

@@ -0,0 +1,59 @@
+require 'digest'
+
+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
+      if cache_expiry_period.blank?
+        result
+      else
+        Rails.cache.fetch(cache_key, expires_in: cache_expiry_period) do
+          result
+        end
+      end
+    end
+
+    private
+
+    attr_reader :subject, :options
+
+    def result
+      raise NotImplementedError
+    end
+
+    def cache_key
+      "#{self.class.name}_#{hash_of(subject, options)}"
+    end
+
+    def self.hash_of(*args)
+      Digest::SHA1.hexdigest(args.map(&:to_s).join(':'))
+    end
+
+    def hash_of(*args)
+      self.class.hash_of(*args)
+    end
+
+    def cache_expiry_period
+      self.class.cache_expiry_every
+    end
+  end
+end

data/lib/patterns/form.rb

@@ -49,8 +49,16 @@ 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&.respond_to?(:persisted?)
+      if resource.present? && resource.respond_to?(:persisted?)
         resource.persisted?
       else
         false
@@ -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&.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/patterns/query.rb

@@ -6,17 +6,17 @@ module Patterns
 
     def initialize(*args)
       @options = args.extract_options!
-      @relation = args.first || self.class.base_relation
+      @relation = args.first || base_relation
 
       if relation.nil?
         raise(
-            RelationRequired,
-            "Queries require a base relation defined. Use .queries method to define relation."
+          RelationRequired,
+          "Queries require a base relation defined. Use .queries method to define relation."
         )
       elsif !relation.is_a?(ActiveRecord::Relation)
         raise(
-            RelationRequired,
-            "Queries accept only ActiveRecord::Relation as input"
+          RelationRequired,
+          "Queries accept only ActiveRecord::Relation as input"
         )
       end
     end
@@ -29,20 +29,25 @@ module Patterns
       query.tap do |relation|
         unless relation.is_a?(ActiveRecord::Relation)
           raise(
-              RelationRequired,
-              "#query method should return object of ActiveRecord::Relation class"
+            RelationRequired,
+            "#query method should return object of ActiveRecord::Relation class"
           )
         end
       end
     end
 
     def self.queries(subject)
-      self.base_relation =
-        if subject.is_a?(ActiveRecord::Relation)
-          subject
-        elsif subject < ActiveRecord::Base
-          subject.all
-        end
+      self.base_relation = subject
+    end
+
+    def base_relation
+      return nil if self.class.base_relation.nil?
+
+      if self.class.base_relation.is_a?(ActiveRecord::Relation)
+        self.class.base_relation
+      elsif self.class.base_relation < ActiveRecord::Base
+        self.class.base_relation.all
+      end
     end
 
     private
@@ -55,8 +60,8 @@ module Patterns
 
     def query
       raise(
-          NotImplementedError,
-          "You need to implement #query method which returns ActiveRecord::Relation object"
+        NotImplementedError,
+        "You need to implement #query method which returns ActiveRecord::Relation object"
       )
     end
   end

data/lib/patterns/rule.rb

@@ -0,0 +1,25 @@
+class Rule
+  def initialize(subject)
+    @subject = subject
+  end
+
+  def satisfied?
+    raise NotImplementedError
+  end
+
+  def not_applicable?
+    false
+  end
+
+  def applicable?
+    !not_applicable?
+  end
+
+  def forceable?
+    true
+  end
+
+  private
+
+  attr_reader :subject
+end

data/lib/patterns/ruleset.rb

@@ -0,0 +1,69 @@
+class Ruleset
+  class EmptyRuleset < StandardError; end
+
+  class << self
+    attr_accessor :rule_names
+  end
+
+  def self.rules
+    (rule_names || []).map do |rule_name|
+      rule_name.to_s.classify.constantize
+    end
+  end
+
+  def self.add_rule(rule_name)
+    self.rule_names ||= []
+    self.rule_names << rule_name.to_sym
+    self
+  end
+
+  def initialize(subject = nil)
+    raise EmptyRuleset if self.class.rules.empty?
+
+    @rules = self.class.rules.map { |rule| rule.new(subject) }
+  end
+
+  def satisfied?(force: false)
+    rules.all? do |rule|
+      rule.satisfied? ||
+        rule.not_applicable? ||
+        (force && rule.forceable?)
+    end
+  end
+
+  def not_satisfied?
+    !satisfied?
+  end
+
+  def applicable?
+    !not_applicable?
+  end
+
+  def not_applicable?
+    rules.all?(&:not_applicable?)
+  end
+
+  def forceable?
+    rules.all? do |rule|
+      rule.forceable? ||
+        rule.not_applicable? ||
+        rule.satisfied?
+    end
+  end
+
+  def each(&block)
+    return enum_for(:each) unless block_given?
+
+    rules.each do |rule_or_ruleset|
+      if rule_or_ruleset.is_a?(Ruleset)
+        rule_or_ruleset.each(&block)
+      else
+        yield rule_or_ruleset
+      end
+    end
+  end
+
+  private
+
+  attr_reader :rules
+end

data/lib/patterns/service.rb

@@ -1,13 +1,17 @@
+require 'ruby2_keywords'
+
 module Patterns
   class Service
     attr_reader :result
 
-    def self.call(*args)
-      new(*args).tap do |service|
-        service.instance_variable_set(
-          "@result",
-          service.call
-        )
+    class << self
+      ruby2_keywords def call(*args)
+        new(*args).tap do |service|
+          service.instance_variable_set(
+            "@result",
+            service.call
+          )
+        end
       end
     end
 

data/lib/patterns/strong_ruleset.rb

@@ -0,0 +1,19 @@
+# StrongRuleset is not satisfied and not forceable if any of rules is not applicable
+
+class StrongRuleset < Ruleset
+  def satisfied?(force: false)
+    rules.all? do |rule|
+      (rule.applicable? && rule.satisfied?) || (force && rule.forceable?)
+    end
+  end
+
+  def not_applicable?
+    rules.any?(&:not_applicable?)
+  end
+
+  def forceable?
+    rules.all? do |rule|
+      (rule.applicable? && rule.forceable?) || rule.satisfied?
+    end
+  end
+end

data/lib/rails-patterns.rb

@@ -2,4 +2,8 @@ require "patterns"
 require "patterns/query"
 require "patterns/service"
 require "patterns/collection"
+require "patterns/calculation"
 require "patterns/form"
+require "patterns/rule"
+require "patterns/ruleset"
+require "patterns/strong_ruleset"

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.0 ruby lib
+# stub: rails-patterns 0.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails-patterns".freeze
-  s.version = "0.4.0"
+  s.version = "0.8.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-21"
+  s.date = "2020-09-01"
   s.description = "A collection of lightweight, standardized, rails-oriented patterns.".freeze
   s.email = "b.kosmowski@selleo.com".freeze
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".github/workflows/ruby.yml",
     ".rspec",
     "Gemfile",
     "Gemfile.lock",
@@ -28,47 +29,54 @@ 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/rule.rb",
+    "lib/patterns/ruleset.rb",
     "lib/patterns/service.rb",
+    "lib/patterns/strong_ruleset.rb",
     "lib/rails-patterns.rb",
     "rails-patterns.gemspec",
+    "spec/helpers/custom_calculation.rb",
+    "spec/helpers/custom_calculation_script.rb",
+    "spec/helpers/rails_redis_cache_mock.rb",
+    "spec/patterns/calculation_spec.rb",
     "spec/patterns/collection_spec.rb",
     "spec/patterns/form_spec.rb",
     "spec/patterns/query_spec.rb",
+    "spec/patterns/rule_spec.rb",
+    "spec/patterns/ruleset_spec.rb",
     "spec/patterns/service_spec.rb",
+    "spec/patterns/strong_ruleset_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/selleo/pattern".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.10".freeze
+  s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
+  s.rubygems_version = "3.1.2".freeze
   s.summary = "A collection of lightweight, standardized, rails-oriented patterns.".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>.freeze, [">= 4.2.6"])
-      s.add_runtime_dependency(%q<actionpack>.freeze, [">= 4.2.6"])
-      s.add_runtime_dependency(%q<virtus>.freeze, [">= 0"])
-      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
-      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
-    else
-      s.add_dependency(%q<activerecord>.freeze, [">= 4.2.6"])
-      s.add_dependency(%q<actionpack>.freeze, [">= 4.2.6"])
-      s.add_dependency(%q<virtus>.freeze, [">= 0"])
-      s.add_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
-      s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<activerecord>.freeze, [">= 4.2.6"])
+    s.add_runtime_dependency(%q<actionpack>.freeze, [">= 4.2.6"])
+    s.add_runtime_dependency(%q<virtus>.freeze, [">= 0"])
+    s.add_runtime_dependency(%q<ruby2_keywords>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_development_dependency(%q<bundler>.freeze, ["~> 2.0"])
+    s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
   else
     s.add_dependency(%q<activerecord>.freeze, [">= 4.2.6"])
     s.add_dependency(%q<actionpack>.freeze, [">= 4.2.6"])
     s.add_dependency(%q<virtus>.freeze, [">= 0"])
+    s.add_dependency(%q<ruby2_keywords>.freeze, [">= 0"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 2.0"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
   end
 end