pragma 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d0c11764865411e45f53f08871eac04c2c56588e
-  data.tar.gz: c38dd3967e1d5a387bddba14caef46579e3d31fb
+SHA256:
+  metadata.gz: 33831eebb49b3b8bbe97ad98221f1a2c17c0bca329c60f4d0eea66c260a5b82a
+  data.tar.gz: e726495b25a7f62cdbdf6e15025963a358ff6e1732ddf45cc7b0a79d34d7f613
 SHA512:
-  metadata.gz: 18043a03e95027f0dbe80a1bbf5a9bfbabdb56bc0f47a8bdf29f5500b8f64081fb8bf845c4653e60483dd5611394e8a7b2bb4063d5946122784432910a46debd
-  data.tar.gz: e12c6b35442c76060402278d739595ce10fde7063bd3d6478ff02ec1b1c7ad3f3a04d342b8b174c3deed2c16e455b1486a6240e88b8a54ff2edb9f893f4779f8
+  metadata.gz: f821889bd9e24a5aaea95039508655f3170a85317b6cb9ee34676fcec99c9e9482dd294667847351ae3768ceccd4f2ad0ce56b68e4ac525662d527e1aea170f6
+  data.tar.gz: f4166fb8b737b3aa26fed21a5b3717a026339b465b4a29d628ef162890a94e1c70a26c597a97f5a5af1e481992dc37c6a4cd3727e0ce20ceb4987e229c84ba88

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-version

data/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.2.0]
+
+### Added
+
+- Added ability to order by an association column
+- Implemented the `action` option for the `Policy` macro
+- Implemented the `Where` filter
+- Implemented the `Scope` filter
+
+### Changed
+
+- Pipetrees have been normalized to use strings and no exclamation marks
+- Move macros to `Pragma::Macro` namespace and provide BC-compatibility
+- Default name of `Contract::Build` steps is now `contract.[name].build`
+- Default name of `Contract::Persist` steps is now `contract.[name].[method]`
+
+### Fixed
+
+- Fixed handling of validation errors in `Contract::Validate`
+- Fixed handling of validation errors in `Contract::Persist`
+
 ## [2.1.1]
 
 ### Fixed
@@ -29,7 +50,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 First Pragma 2 release.
 
-[Unreleased]: https://github.com/pragmarb/pragma/compare/v2.1.1...HEAD
+[Unreleased]: https://github.com/pragmarb/pragma/compare/v2.2.0...HEAD
+[2.2.0]: https://github.com/pragmarb/pragma/compare/v2.1.1...v2.2.0
 [2.1.1]: https://github.com/pragmarb/pragma/compare/v2.1.0...v2.1.1
 [2.1.0]: https://github.com/pragmarb/pragma/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/pragmarb/pragma/compare/v1.2.6...v2.0.0

data/README.md

@@ -167,7 +167,7 @@ module API
       module Operation
         class Create < Pragma::Operation::Base
           # Let the macro figure out class names.
-          step Pragma::Operation::Macro::Classes()
+          step Pragma::Macro::Classes()
           step :execute!
           
           # But override the contract.
@@ -211,7 +211,7 @@ module API
           # This step can be done by Classes if you want.
           self['model.class'] = ::Article
            
-          step Pragma::Operation::Macro::Model(:build)
+          step Pragma::Macro::Model(:build)
           step :save!
           
           def save!(options)
@@ -239,7 +239,7 @@ module API
           # This step can be done by Classes if you want.
           self['model.class'] = ::Article
            
-          step Pragma::Operation::Macro::Model(:find_by), fail_fast: true
+          step Pragma::Macro::Model(:find_by), fail_fast: true
           step :respond!
           
           def respond!(options)
@@ -276,7 +276,9 @@ module API
           self['policy.default.class'] = Policy
           
           step :model!
-          step Pragma::Operation::Macro::Policy(), fail_fast: true
+          step Pragma::Macro::Policy(), fail_fast: true
+          # You can also specify a custom method to call on the policy:
+          # step Pragma::Macro::Policy(action: :custom_method), fail_fast: true
           step :respond!
           
           def model!(params:, **)
@@ -308,12 +310,12 @@ module API
       module Operation
         class Index < Pragma::Operation::Base
           step :model!
-          step Pragma::Operation::Macro::Filtering()
+          step Pragma::Macro::Filtering()
           step :respond!
 
           self['filtering.filters'] = [
-            Pragma::Operation::Filter::Equals.new(param: :by_category, column: :category_id),
-            Pragma::Operation::Filter::Ilike.new(param: :by_title, column: :title)
+            Pragma::Filter::Equals.new(param: :by_category, column: :category_id),
+            Pragma::Filter::Ilike.new(param: :by_title, column: :title)
           ]
           
           def model!(params:, **)
@@ -326,12 +328,17 @@ module API
 end
 ```
 
-With the example above, you are exposing the `by_category` filter and the `by_title` filters. The 
-following filters are available for ActiveRecord currently:
+With the example above, you are exposing the `by_category` filter and the `by_title` filters. 
 
-- `Equals`: performs an equality (`=`) comparison.
-- `Like`: performs a `LIKE` comparison.
-- `Ilike`: performs an `ILIKE` comparison.
+The following filters are available for ActiveRecord currently:
+
+- `Equals`: performs an equality (`=`) comparison (requires `:column`)-
+- `Like`: performs a `LIKE` comparison (requires `:column`).
+- `Ilike`: performs an `ILIKE` comparison (requires `:column`).
+- `Where`: adds a generic `WHERE` clause (requires `:condition` and passes the parameter's value as 
+   `:value`).
+- `Scope`: calls a method on the collection (requires `:scope` and passes the parameter's value as 
+   the first argument).
 
 Support for more clauses as well as more ORMs will come soon.
 
@@ -360,7 +367,7 @@ module API
           step :model!
 
           # This will override `model` with the ordered relation.
-          step Pragma::Operation::Macro::Ordering(), fail_fast: true
+          step Pragma::Macro::Ordering(), fail_fast: true
 
           step :respond!
 
@@ -412,7 +419,7 @@ module API
           step :model!
 
           # This will override `model` with the paginated relation.
-          step Pragma::Operation::Macro::Pagination(), fail_fast: true
+          step Pragma::Macro::Pagination(), fail_fast: true
 
           step :respond!
 
@@ -468,7 +475,7 @@ module API
           self['decorator.instance.class'] = Decorator::Instance
           
           step :model!
-          step Pragma::Operation::Macro::Decorator(), fail_fast: true
+          step Pragma::Macro::Decorator(), fail_fast: true
           step :respond!
           
           def model!(params:, **)

data/lib/pragma.rb

@@ -12,21 +12,27 @@ require 'pragma/version'
 
 require 'pragma/decorator/error'
 
-require 'pragma/operation/filter/base'
-require 'pragma/operation/filter/equals'
-require 'pragma/operation/filter/like'
-require 'pragma/operation/filter/ilike'
-
-require 'pragma/operation/macro/classes'
-require 'pragma/operation/macro/decorator'
-require 'pragma/operation/macro/filtering'
-require 'pragma/operation/macro/ordering'
-require 'pragma/operation/macro/pagination'
-require 'pragma/operation/macro/policy'
-require 'pragma/operation/macro/model'
-require 'pragma/operation/macro/contract/build'
-require 'pragma/operation/macro/contract/validate'
-require 'pragma/operation/macro/contract/persist'
+require 'pragma/filter/base'
+require 'pragma/filter/equals'
+require 'pragma/filter/like'
+require 'pragma/filter/ilike'
+require 'pragma/filter/where'
+require 'pragma/filter/scope'
+
+require 'pragma/operation/filter'
+
+require 'pragma/macro/classes'
+require 'pragma/macro/decorator'
+require 'pragma/macro/filtering'
+require 'pragma/macro/ordering'
+require 'pragma/macro/pagination'
+require 'pragma/macro/policy'
+require 'pragma/macro/model'
+require 'pragma/macro/contract/build'
+require 'pragma/macro/contract/validate'
+require 'pragma/macro/contract/persist'
+
+require 'pragma/operation/macro'
 
 require 'pragma/operation/index'
 require 'pragma/operation/show'

data/lib/pragma/filter/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Filter
+    class Base
+      attr_reader :param
+
+      def initialize(param:)
+        @param = param.to_sym
+      end
+
+      def apply(*)
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/pragma/filter/equals.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Filter
+    class Equals < Base
+      attr_reader :column
+
+      def initialize(column:, **other)
+        super(**other)
+        @column = column
+      end
+
+      def apply(relation:, value:)
+        relation.where(column => value)
+      end
+    end
+  end
+end

data/lib/pragma/filter/ilike.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Filter
+    class Ilike < Base
+      attr_reader :column
+
+      def initialize(column:, **other)
+        super(**other)
+        @column = column
+      end
+
+      def apply(relation:, value:)
+        relation.where("#{column} ILIKE ?", "%#{value}%")
+      end
+    end
+  end
+end

data/lib/pragma/filter/like.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Filter
+    class Like < Base
+      attr_reader :column
+
+      def initialize(column:, **other)
+        super(**other)
+        @column = column
+      end
+
+      def apply(relation:, value:)
+        relation.where("#{column} LIKE ?", "%#{value}%")
+      end
+    end
+  end
+end

data/lib/pragma/filter/scope.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Filter
+    class Scope < Base
+      attr_reader :scope
+
+      def initialize(scope:, **other)
+        super(**other)
+        @scope = scope
+      end
+
+      def apply(relation:, value:)
+        relation.public_send(scope, value)
+      end
+    end
+  end
+end

data/lib/pragma/filter/where.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Filter
+    class Where < Base
+      attr_reader :condition
+
+      def initialize(condition:, **other)
+        super(**other)
+        @condition = condition
+      end
+
+      def apply(relation:, value:)
+        relation.where(condition, value: value)
+      end
+    end
+  end
+end

data/lib/pragma/macro/classes.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Macro
+    def self.Classes
+      step = ->(input, options) { Classes.for(input, options) }
+      [step, name: 'classes']
+    end
+
+    module Classes
+      class << self
+        def for(input, options)
+          {
+            'model.class' => expected_model_class(input, options),
+            'policy.default.class' => expected_policy_class(input, options),
+            'policy.default.scope.class' => expected_policy_scope_class(input, options),
+            'decorator.instance.class' => expected_instance_decorator_class(input, options),
+            'decorator.collection.class' => expected_collection_decorator_class(input, options),
+            'contract.default.class' => expected_contract_class(input, options)
+          }.each_pair do |key, value|
+            next if options[key]
+
+            # FIXME: This entire block is required to trigger Rails autoloading. Ugh.
+            begin
+              Object.const_get(value)
+            rescue NameError => e
+              # We check the error message to avoid silently ignoring other NameErrors
+              # thrown while initializing the constant.
+              if e.message.start_with?('uninitialized constant')
+                # Required instead of a simple equality check because loading
+                # API::V1::Post::Contract::Index might throw "uninitialized constant
+                # API::V1::Post::Contract" if the resource has no contracts at all.
+                error_constant = e.message.split.last
+                raise e unless value.sub(/\A::/, '').start_with?(error_constant)
+              end
+            end
+
+            options[key] = (Object.const_get(value) if Object.const_defined?(value))
+          end
+        end
+
+        private
+
+        def resource_namespace(input, _options)
+          input.class.name.split('::')[0..-3]
+        end
+
+        def root_namespace(input, options)
+          resource_namespace = resource_namespace(input, options)
+          return [] if resource_namespace.first == 'API'
+          resource_namespace[0..((resource_namespace.index('API') || 1) - 1)]
+        end
+
+        def expected_model_class(input, options)
+          [
+            root_namespace(input, options).join('::'),
+            resource_namespace(input, options).last
+          ].join('::')
+        end
+
+        def expected_policy_class(input, options)
+          [
+            resource_namespace(input, options),
+            'Policy'
+          ].join('::')
+        end
+
+        def expected_policy_scope_class(input, options)
+          "#{expected_policy_class(input, options)}::Scope"
+        end
+
+        def expected_instance_decorator_class(input, options)
+          [
+            resource_namespace(input, options),
+            'Decorator',
+            'Instance'
+          ].join('::')
+        end
+
+        def expected_collection_decorator_class(input, options)
+          [
+            resource_namespace(input, options),
+            'Decorator',
+            'Collection'
+          ].join('::')
+        end
+
+        def expected_contract_class(input, options)
+          [
+            resource_namespace(input, options),
+            'Contract',
+            input.class.name.split('::').last
+          ].join('::')
+        end
+      end
+    end
+  end
+end

data/lib/pragma/macro/contract/build.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'trailblazer/operation/contract'
+
+module Pragma
+  module Macro
+    module Contract
+      def self.Build(name: 'default', constant: nil, builder: nil)
+        step = lambda do |input, options|
+          Trailblazer::Operation::Contract::Build.for(
+            input,
+            options,
+            name: name,
+            constant: constant,
+            builder: builder
+          ).tap do |contract|
+            contract.current_user = options['current_user']
+          end
+        end
+
+        [step, name: "contract.#{name}.build"]
+      end
+    end
+  end
+end

data/lib/pragma/macro/contract/persist.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'trailblazer/operation/persist'
+
+module Pragma
+  module Macro
+    module Contract
+      def self.Persist(method: :save, name: 'default')
+        step = lambda do |input, options|
+          Trailblazer::Operation::Pipetree::Step.new(
+            Trailblazer::Operation::Contract::Persist(method: method, name: name).first
+          ).call(input, options).tap do |result|
+            unless result
+              options['result.response'] = Pragma::Operation::Response::UnprocessableEntity.new(
+                errors: options["contract.#{name}"].model.errors.messages
+              ).decorate_with(Pragma::Decorator::Error)
+            end
+          end
+        end
+
+        [step, name: "contract.#{name}.#{method}"]
+      end
+    end
+  end
+end