law 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e74cd15524ae8f0731bcb351779158496be3fa61a49e7e3553a53a0bfd5fdcff
-  data.tar.gz: fa7920650d8debe57a1bbcafa2b6cabf1e9b617783a3f22edc9568a9e7eea359
+  metadata.gz: 2e2ac1483d7b8253bb52289a1c81727bbfc15f47a60f0f03ab7f7f9c78e38d69
+  data.tar.gz: ab18b48276b107552e3335cd8dfc17e98d04a764aef9655ca369d40b5c6fae10
 SHA512:
-  metadata.gz: cb1bda1a9cfbbe9205453a318d2ef783e2adc62ce13bdea457e76c93f07194d4531265c0d3284eb866c722aed16853696d6283a7d590de5f8a90145ef441b7bd
-  data.tar.gz: 866e1524f3d77b29d872ade4758faa389889a114a6a287b68fae0772fa5371658a4be22cc9d5c1cdb87e6f046068c864a4af3838a5ed35cf965d8aadace18de8
+  metadata.gz: 259728e11d27c2c78829433b4dcd6e6d6f869533c7637002b6823c498523e5bc8353a2ffcd307556d09b94095ea435cf963bf4ae6fe88234ae1e6fe90fecc437
+  data.tar.gz: 6383a6bd485a6ea5ad111095bc8df0e961c570ef54206f5139eb7c8ad2b742501d427656e79a26e2838b3a0ccef224401a9e8c564ceb9eadb55b14d78600f152

data/lib/generators/law/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Stub a Law with a test.
+
+Example:
+    `rails generate law foo`
+
+    Generates:
+       Law: app/laws/foo_law.rb
+       Test: spec/laws/foo_law_spec.rb

data/lib/generators/law/law_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Law
+  module Generators
+    class LawGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      hook_for :test_framework
+
+      def create_law
+        template "law.rb.erb", File.join("app/laws/", class_path, "#{file_name}_law.rb")
+      end
+    end
+  end
+end

data/lib/generators/law/regulation/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Stub a Regulation with a test.
+
+Example:
+    `rails generate law:regulation foo`
+
+    Generates:
+       Regulation: app/regulations/foo_regulation.rb
+       Test: spec/regulations/foo_regulation_spec.rb

data/lib/generators/law/regulation/regulation_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Law
+  module Generators
+    class RegulationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      hook_for :test_framework
+
+      def create_regulation
+        template "regulation.rb.erb", File.join("app/regulations/", class_path, "#{file_name}_regulation.rb")
+      end
+    end
+  end
+end

data/lib/generators/law/regulation/templates/regulation.rb.erb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Regulation < ApplicationRegulation
+end

data/lib/generators/law/statute/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Stub a Statute with a test.
+
+Example:
+    `rails generate law:statute foo`
+
+    Generates:
+       Statute: app/statutes/foo_statute.rb
+       Test: spec/statutes/foo_statute_spec.rb

data/lib/generators/law/statute/statute_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Law
+  module Generators
+    class StatuteGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      hook_for :test_framework
+
+      def create_statute
+        template "statute.rb.erb", File.join("app/statutes/", class_path, "#{file_name}_statute.rb")
+      end
+    end
+  end
+end

data/lib/generators/law/statute/templates/statute.rb.erb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Statute < ApplicationStatute
+end

data/lib/generators/law/templates/law.rb.erb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Law < ApplicationLaw
+end

data/lib/generators/rspec/law/USAGE

@@ -0,0 +1,9 @@
+
+Description:
+    Stub a Law test.
+
+Example:
+    `rails generate rspec:law foo`
+
+    Generates:
+      Test: spec/laws/foo_law_spec.rb

data/lib/generators/rspec/law/law_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class LawGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "law_spec.rb.erb", File.join("spec/laws/", class_path, "#{file_name}_law_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/law/templates/law_spec.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe <%= class_name %>Law, type: :law do
+  it { is_expected.to inherit_from ApplicationLaw }
+end

data/lib/generators/rspec/regulation/USAGE

@@ -0,0 +1,9 @@
+
+Description:
+    Stub a Regulation test.
+
+Example:
+    `rails generate rspec:regulation foo`
+
+    Generates:
+      Test: spec/regulations/foo_regulation_spec.rb

data/lib/generators/rspec/regulation/regulation_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class RegulationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "regulation_spec.rb.erb", File.join("spec/regulations/", class_path, "#{file_name}_regulation_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/regulation/templates/regulation_spec.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe <%= class_name %>Regulation, type: :regulation do
+  it { is_expected.to inherit_from ApplicationRegulation }
+end

data/lib/generators/rspec/statute/USAGE

@@ -0,0 +1,9 @@
+
+Description:
+    Stub a Statute test.
+
+Example:
+    `rails generate rspec:statute foo`
+
+    Generates:
+      Test: spec/statutes/foo_statute_spec.rb

data/lib/generators/rspec/statute/statute_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class StatuteGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "statute_spec.rb.erb", File.join("spec/statutes/", class_path, "#{file_name}_statute_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/statute/templates/statute_spec.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe <%= class_name %>Statute, type: :statute do
+  it { is_expected.to inherit_from ApplicationStatute }
+end

data/lib/law.rb

@@ -2,6 +2,7 @@
 
 require "active_support"
 require "active_support/core_ext/enumerable"
+require "active_support/hash_with_indifferent_access"
 
 require "spicery"
 
@@ -27,4 +28,5 @@ module Law
 
   class NotAuthorizedError < Error; end
   class InjunctionError < NotAuthorizedError; end
+  class ComplianceError < NotAuthorizedError; end
 end

data/lib/law/judgement.rb

@@ -15,7 +15,7 @@ module Law
 
     attr_reader :petition, :violations, :applied_regulations
 
-    delegate :statute, :applicable_regulations, to: :petition
+    delegate :statute, :applicable_regulations, :compliant?, to: :petition, allow_nil: true
 
     def initialize(petition)
       @petition = petition
@@ -39,20 +39,30 @@ module Law
     end
 
     def judge!
-      if statute.unregulated?
+      raise AlreadyJudgedError if adjudicated?
+
+      if statute&.unregulated?
         @applied_regulations = [ nil ]
         return true
       end
 
+      ensure_jurisdiction
+      reckon!
+
+      true
+    end
+
+    private
+
+    def ensure_jurisdiction
       raise InjunctionError if applicable_regulations.blank?
-      raise AlreadyJudgedError if adjudicated?
+      raise ComplianceError unless compliant?
+    end
 
+    def reckon!
       @applied_regulations = applicable_regulations.map { |regulation| regulation.new(petition: petition) }
       @violations = applied_regulations.reject(&:valid?)
-
       raise NotAuthorizedError unless authorized?
-
-      true
     end
   end
 end

data/lib/law/laws/actions.rb

@@ -8,22 +8,32 @@ module Law
 
       included do
         class_attribute :actions, instance_writer: false, default: HashWithIndifferentAccess.new
+        class_attribute :revoked_actions, instance_writer: false, default: HashWithIndifferentAccess.new
 
-        delegate :statute_for_action?, to: :class
+        delegate :statute_for_action?, :revoked_action?, to: :class
       end
 
       class_methods do
         def inherited(base)
           base.actions = actions.dup
+          base.revoked_actions = revoked_actions.dup
           super
         end
 
+        def revoked_action?(action)
+          revoked_actions[action].present?
+        end
+
         def statute_for_action?(action)
           actions[action].present?
         end
 
         private
 
+        def revoke_action(*input_actions)
+          input_actions.each { |action| revoked_actions[action] = true }
+        end
+
         def define_action(*input_actions, enforces: nil)
           raise ArgumentError, "invalid statute: #{enforces}" unless enforceable?(enforces)
 

data/lib/law/laws/petitions.rb

@@ -14,6 +14,8 @@ module Law
       end
 
       def petition_for_action(action)
+        return if revoked_action?(action)
+
         Law::Petition.new(
           statute: actions[action] || _default_statute,
           source: source,

data/lib/law/legalize.rb

@@ -23,7 +23,7 @@ module Law
     end
 
     def law(object = nil, petitioner = nil, permissions: nil, parameters: nil, law_class: nil)
-      object ||= try(:controller_name)&.singularize&.camelize&.safe_constantize
+      object ||= @record || try(:controller_name)&.singularize&.camelize&.safe_constantize
       petitioner ||= try(:current_user)
       permissions ||= petitioner.try(:permissions)
       law_class ||= object.try(:conjugate, Law::LawBase)

data/lib/law/petition.rb

@@ -18,5 +18,11 @@ module Law
       statute.regulations.select { |regulation| permission_list.include? regulation.key }
     end
     memoize :applicable_regulations
+
+    def compliant?
+      return applicable_regulations.any? unless statute.full_compliance_required?
+
+      statute.regulations == applicable_regulations
+    end
   end
 end

data/lib/law/rspec/custom_matchers.rb

@@ -6,3 +6,4 @@ require_relative "custom_matchers/be_imposed_by"
 require_relative "custom_matchers/define_action"
 require_relative "custom_matchers/have_default_statute"
 require_relative "custom_matchers/impose_regulations"
+require_relative "custom_matchers/revoke_action"

data/lib/law/rspec/custom_matchers/revoke_action.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests revoking of statutes in laws.
+#
+#     class ExampleStatute < ApplicationStatute
+#     end
+#
+#     class CommonLaw < ApplicationStatute
+#       define_action :new, enforces: ExampleRegulation
+#       define_action :create, enforces: ExampleRegulation
+#       define_action :edit
+#     end
+#
+#     class ExampleLaw < CommonLaw
+#       revoke_action :new, :edit
+#     end
+#
+#     RSpec.describe ExampleLaw, type: :law do
+#       it { is_expected.to revoke_action :new, :edit }
+#     end
+
+RSpec::Matchers.define :revoke_action do |*actions|
+  match do
+    actions.each { |action| expect(test_subject.revoked_action?(action)).to eq true }
+  end
+  description { "revoke #{"action".pluralize(actions.length)} #{actions.join(", ")}" }
+  failure_message { "expected #{test_subject} to revoke #{"action".pluralize(actions.length)} #{actions.join(", ")}" }
+  failure_message_when_negated do
+    "expected #{test_subject} not to revoke #{"action".pluralize(actions.length)} #{actions.join(", ")}"
+  end
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/law/statute_base.rb

@@ -2,11 +2,13 @@
 
 require_relative "statutes/regulations"
 require_relative "statutes/laws"
+require_relative "statutes/compliance"
 
 # A **Statute** restricts actions to **Actors** by enforcing a collection of **Permissions**.
 module Law
   class StatuteBase < Spicerack::RootObject
     include Law::Statutes::Regulations
     include Law::Statutes::Laws
+    include Law::Statutes::Compliance
   end
 end

data/lib/law/statutes/compliance.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# A **Statute** is a collection of imposed **Regulations** with some **Compliance** rules.
+module Law
+  module Statutes
+    module Compliance
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def full_compliance_required?
+          @require_full_compliance.present?
+        end
+
+        def inherited(base)
+          base.require_full_compliance if full_compliance_required?
+          super
+        end
+
+        protected
+
+        def require_full_compliance
+          @require_full_compliance = true
+        end
+      end
+    end
+  end
+end

data/lib/law/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Law
-  VERSION = "0.1.3"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: law
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Eric Garside
+- Brandon Trumpold
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,21 +17,21 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 6.0.3.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 6.0.3.7
 - !ruby/object:Gem::Dependency
   name: spicery
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.3.1
+        version: 0.26.0.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -40,7 +41,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.3.1
+        version: 0.26.0.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -134,7 +135,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.3.1
+        version: 0.26.0.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -144,7 +145,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.3.1
+        version: 0.26.0.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -154,7 +155,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.3.1
+        version: 0.26.0.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -164,7 +165,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.3.1
+        version: 0.26.0.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -172,12 +173,31 @@ description: Enforce the laws of your Rails application with highly extensible a
   policies
 email:
 - garside@gmail.com
+- brandon.trumpold@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- lib/generators/law/USAGE
+- lib/generators/law/law_generator.rb
+- lib/generators/law/regulation/USAGE
+- lib/generators/law/regulation/regulation_generator.rb
+- lib/generators/law/regulation/templates/regulation.rb.erb
+- lib/generators/law/statute/USAGE
+- lib/generators/law/statute/statute_generator.rb
+- lib/generators/law/statute/templates/statute.rb.erb
+- lib/generators/law/templates/law.rb.erb
+- lib/generators/rspec/law/USAGE
+- lib/generators/rspec/law/law_generator.rb
+- lib/generators/rspec/law/templates/law_spec.rb.erb
+- lib/generators/rspec/regulation/USAGE
+- lib/generators/rspec/regulation/regulation_generator.rb
+- lib/generators/rspec/regulation/templates/regulation_spec.rb.erb
+- lib/generators/rspec/statute/USAGE
+- lib/generators/rspec/statute/statute_generator.rb
+- lib/generators/rspec/statute/templates/statute_spec.rb.erb
 - lib/law.rb
 - lib/law/judgement.rb
 - lib/law/law_base.rb
@@ -198,9 +218,11 @@ files:
 - lib/law/rspec/custom_matchers/define_action.rb
 - lib/law/rspec/custom_matchers/have_default_statute.rb
 - lib/law/rspec/custom_matchers/impose_regulations.rb
+- lib/law/rspec/custom_matchers/revoke_action.rb
 - lib/law/rspec/shoulda_matcher_helper.rb
 - lib/law/spec_helper.rb
 - lib/law/statute_base.rb
+- lib/law/statutes/compliance.rb
 - lib/law/statutes/laws.rb
 - lib/law/statutes/regulations.rb
 - lib/law/version.rb
@@ -226,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Give illegal operations a whole new meaning with this policy enforcement