pragma 1.2.6 → 2.0.0

data/lib/pragma/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Pragma
-  VERSION = '1.2.6'
+  VERSION = '2.0.0'
 end

data/pragma.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pragma/version'
@@ -20,10 +21,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'pragma-operation', '~> 1.2'
-  spec.add_dependency 'pragma-policy', '~> 0.1'
-  spec.add_dependency 'pragma-contract', '~> 0.1'
-  spec.add_dependency 'pragma-decorator', '~> 1.0'
+  spec.add_dependency 'trailblazer', '~> 2.0'
+  spec.add_dependency 'pragma-operation', '~> 2.0'
+  spec.add_dependency 'pragma-policy', '~> 2.0'
+  spec.add_dependency 'pragma-contract', '~> 2.0'
+  spec.add_dependency 'pragma-decorator', '~> 2.0'
   spec.add_dependency 'will_paginate', '~> 3.1'
 
   spec.add_development_dependency 'bundler'

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: pragma
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: trailblazer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pragma-operation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pragma-policy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pragma-contract
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pragma-decorator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -182,13 +196,19 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- doc/01-sensible-defaults.md
-- doc/02-crud-operations.md
 - lib/pragma.rb
+- lib/pragma/decorator/error.rb
 - lib/pragma/operation/create.rb
-- lib/pragma/operation/defaults.rb
 - lib/pragma/operation/destroy.rb
 - lib/pragma/operation/index.rb
+- lib/pragma/operation/macro/classes.rb
+- lib/pragma/operation/macro/contract/build.rb
+- lib/pragma/operation/macro/contract/persist.rb
+- lib/pragma/operation/macro/contract/validate.rb
+- lib/pragma/operation/macro/decorator.rb
+- lib/pragma/operation/macro/model.rb
+- lib/pragma/operation/macro/pagination.rb
+- lib/pragma/operation/macro/policy.rb
 - lib/pragma/operation/show.rb
 - lib/pragma/operation/update.rb
 - lib/pragma/version.rb
@@ -213,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A pragmatic architecture for building JSON APIs with Ruby.

data/doc/01-sensible-defaults.md

@@ -1,50 +0,0 @@
-# Sensible defaults
-
-This gem works best if you follow the recommended structure (partially borrowed from
-[Trailblazer](https://github.com/trailblazer/trailblazer)) for organizing resources:
-
-```
-└── api
-    └── v1
-        └── post
-            ├── contract
-            │   ├── create.rb
-            │   └── update.rb
-            ├── operation
-            │   ├── create.rb
-            │   ├── destroy.rb
-            │   ├── index.rb
-            │   └── update.rb
-            └── policy.rb
-            └── decorator.rb
-```
-
-Your modules and classes would, of course, follow the same structure: `API::V1::Post::Policy`,
-`API::V1::Post::Operation::Create` and so on and so forth.
-
-If you adhere to this structure, the gem will be able to locate all of your classes without explicit
-configuration (i.e. no `#policy` or `#contract` calls etc.). This will save you a lot of time and is
-highly recommended, especially when used in conjunction with the provided CRUD operations.
-
-To leverage automatic discovery, include `Pragma::Operation::Defaults` in your operation:
-
-```ruby
-module API
-  module V1
-    module Post
-      module Operation
-        class Create < Pragma::Operation::Base
-          include Pragma::Operation::Defaults
-
-          def call
-            # You can use `decorate`, `validate` and `authorize` without having to explicitly
-            # specify the decorator, validator and policy classes.
-            #
-            # ...
-          end
-        end
-      end
-    end
-  end
-end
-```

data/doc/02-crud-operations.md

@@ -1,109 +0,0 @@
-# CRUD operations
-
-Pragma ships with a default set of CRUD operations which should work for most standard API
-resources. You can use them as they are, modify them or simply roll your own.
-
-## The Index operation
-
-Pragma provides a default implementation of the Index operation. Here's how it works:
-
-1. it finds all records of the model;
-2. it wraps the query in the policy to only return viewable records;
-3. it responds with 200 OK and a paginated list of decorated records.
-
-To create an Index operation, inherit from `Pragma::Operation::Index`:
-
-```ruby
-module API
-  module V1
-    module Post
-      module Operation
-        class Index < Pragma::Operation::Index
-        end
-      end
-    end
-  end
-end
-```
-
-To override the defaults of this operation, have a look at the [source code](https://github.com/pragmarb/pragma/blob/master/lib/pragma/operation/index.rb).
-
-## The Create operation
-
-Pragma provides a default implementation of the Create operation. Here's how it works:
-
-1. it builds a new instance of the model;
-2. it wraps the model in the Create contract;
-3. it validates and authorizes the contract;
-4. it saves the record;
-5. it responds with 201 Created and the decorated record.
-
-To create a Create operation (pun intended), inherit from `Pragma::Operation::Create`:
-
-```ruby
-module API
-  module V1
-    module Post
-      module Operation
-        class Create < Pragma::Operation::Create
-        end
-      end
-    end
-  end
-end
-```
-
-To override the defaults of this operation, have a look at the [source code](https://github.com/pragmarb/pragma/blob/master/lib/pragma/operation/create.rb).
-
-## The Update operation
-
-Pragma provides a default implementation of the Update operation. Here's how it works:
-
-1. it finds an instance of the model by ID;
-2. it wraps the model in the Update contract;
-3. it validates and authorizes the contract;
-4. it saves the record;
-5. it responds with 200 OK and the decorated record.
-
-To create an Update operation, inherit from `Pragma::Operation::Update`:
-
-```ruby
-module API
-  module V1
-    module Post
-      module Operation
-        class Update < Pragma::Operation::Update
-        end
-      end
-    end
-  end
-end
-```
-
-To override the defaults of this operation, have a look at the [source code](https://github.com/pragmarb/pragma/blob/master/lib/pragma/operation/update.rb).
-
-## The Destroy operation
-
-Pragma provides a default implementation of the Destroy operation. Here's how it works:
-
-1. it finds an instance of the model by ID;
-2. it authorizes the record;
-3. it destroys the record;
-4. it responds with 204 No Content.
-
-To create a Destroy operation, inherit from `Pragma::Operation::Destroy`:
-
-```ruby
-module API
-  module V1
-    module Post
-      module Operation
-        class Destroy < Pragma::Operation::Destroy
-        end
-      end
-    end
-  end
-end
-```
-
-To override the defaults of this operation, have a look at the [source code](https://github.com/pragmarb/pragma/blob/master/lib/pragma/operation/destroy.rb).

data/lib/pragma/operation/defaults.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-module Pragma
-  module Operation
-    # Provides support for inferring decorator, policy and contract names from the class name.
-    #
-    # @author Alessandro Desantis
-    module Defaults
-      def self.included(klass)
-        klass.extend ClassMethods
-      end
-
-      module ClassMethods # :nodoc:
-        # Returns the decorator class for the current resource (if the inferred class exists).
-        #
-        # If the operation name is +API::V1::Post::Operation::Show+, returns
-        # +API::V1::Post::Decorator+.
-        #
-        # @return [Class]
-        def decorator_klass
-          super || (
-            Object.const_get(computed_decorator_klass) if class_exists?(computed_decorator_klass)
-          )
-        end
-
-        # Returns the policy class for the current resource (if the inferred class exists).
-        #
-        # If the operation name is +API::V1::Post::Operation::Show+, returns
-        # +API::V1::Post::Policy+.
-        #
-        # @return [Class]
-        def policy_klass
-          super || (
-            Object.const_get(computed_policy_klass) if class_exists?(computed_policy_klass)
-          )
-        end
-
-        # Returns the contract class for the current resource (if the inferred class exists).
-        #
-        # If the operation name is +API::V1::Post::Operation::Create+, returns
-        # +API::V1::Post::Contract::Create+.
-        #
-        # @return [Class]
-        def contract_klass
-          super || (
-            Object.const_get(computed_contract_klass) if class_exists?(computed_contract_klass)
-          )
-        end
-
-        # Returns the model class for the current resource (if the inferred class exists).
-        #
-        # If the operation name is +API::V1::Post::Operation::Create+, returns +::Post+.
-        def model_klass
-          Object.const_get("::#{name.split('::')[0..-3].last}")
-        end
-
-        private
-
-        def computed_decorator_klass
-          (name.split('::')[0..-3] << 'Decorator').join('::')
-        end
-
-        def computed_policy_klass
-          (name.split('::')[0..-3] << 'Policy').join('::')
-        end
-
-        def computed_contract_klass
-          name_parts = name.split('::')
-          (name_parts[0..-3] << 'Contract' << name_parts.last).join('::')
-        end
-
-        def class_exists?(klass)
-          begin
-            Object.const_get(klass)
-          rescue NameError => e
-            raise e unless e.message.include?("uninitialized constant #{klass}")
-          end
-
-          Object.const_defined?(klass)
-        end
-      end
-    end
-  end
-end