pragma-rails 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b813fe8cf53b4558b118cca550eb851dff77b9f4
-  data.tar.gz: 7e675468e6837c1a63b4e8c957bf701232446b56
+  metadata.gz: 84f5e5aa2aaa165d80723c35f5f0ad2f94e4e18c
+  data.tar.gz: 27402000c2a1f980b0ea8edc6557b3415834d468
 SHA512:
-  metadata.gz: 5a2a1055ba16a3bd8a7feb6a67a03af1a140d6470aa814a62677c5ef8b77fc598486d16eb17da2d0e6f44624dc7740a9c4610148526285c74bdb80fc6fc8a1a8
-  data.tar.gz: 63dc8ac52215dab16588f3906ad9c0a9226a2ef481d7852fd82e640f0c9cba317e8888b9da62b28ccd56e3b0b6f12a7541f9d3b96d98966acabcebeb93c93955
+  metadata.gz: af7b4c4bf91ed7517c44abb04927888953e228f9c8c4c69c110afa93be69ab6754f505a722c26bc391b6f8c3170527066247bc61026a5f58c0412a9c5fc2c620
+  data.tar.gz: b4a1249b7a4452a332fb8ee7e450b34f90f899c0acf6fc04c19e1bdda03d1627d83724229b1c16aa5afd31123429a3deb647cc11d3f20a31869399ff8df79248

data/.rubocop.yml

@@ -25,30 +25,30 @@ Style/BlockDelimiters:
   Exclude:
     - 'spec/**/*'
 
-Style/FileName:
+Naming/FileName:
   Exclude:
     - 'pragma-rails.gemspec'
 
-Style/AlignParameters:
+Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
-Style/ClosingParenthesisIndentation:
+Layout/ClosingParenthesisIndentation:
   Enabled: false
 
 Metrics/LineLength:
   Max: 100
   AllowURI: true
 
-Style/FirstParameterIndentation:
+Layout/FirstParameterIndentation:
   Enabled: false
 
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-Style/IndentArray:
+Layout/IndentArray:
   EnforcedStyle: consistent
 
-Style/IndentHash:
+Layout/IndentHash:
   EnforcedStyle: consistent
 
 Style/SignalException:
@@ -73,7 +73,7 @@ RSpec/NamedSubject:
 RSpec/ExampleLength:
   Enabled: false
 
-Style/MultilineMethodCallBraceLayout:
+Layout/MultilineMethodCallBraceLayout:
   Enabled: false
 
 Metrics/MethodLength:
@@ -99,3 +99,7 @@ RSpec/MessageExpectation:
 
 RSpec/MessageSpies:
   Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integration/**/*'

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.1.0]
+
+### Added
+
+- Implemented support for using the generators in mountable engines
+
+### Changed
+
+- Replaced `feature` with `include` in generators and tests
+
+### Fixed
+
+- Fixed edge cases in collection rendering for resources without a decorator
+
+## [2.0.0]
+
+First Pragma 2 release.
+
+[Unreleased]: https://github.com/pragmarb/pragma-rails/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/pragmarb/pragma-rails/compare/v2.0.0...v2.1.0
+[2.0.0]: https://github.com/pragmarb/pragma-rails/compare/v1.2.4...v2.0.0

data/Gemfile

@@ -2,9 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pragma-rails.gemspec
 gemspec
-
-gem 'pragma', github: 'pragmarb/pragma'
-gem 'pragma-operation', github: 'pragmarb/pragma-operation'
-gem 'pragma-contract', github: 'pragmarb/pragma-contract'
-gem 'pragma-policy', github: 'pragmarb/pragma-policy'
-gem 'pragma-decorator', github: 'pragmarb/pragma-decorator'

data/README.md

@@ -1,9 +1,9 @@
 # Pragma on Rails
 
-[![Build Status](https://img.shields.io/travis/pragmarb/pragma-rails.svg?maxAge=3600&style=flat-square)](https://travis-ci.org/pragmarb/pragma-rails)
-[![Dependency Status](https://img.shields.io/gemnasium/pragmarb/pragma-rails.svg?maxAge=3600&style=flat-square)](https://gemnasium.com/github.com/pragmarb/pragma-rails)
-[![Code Climate](https://img.shields.io/codeclimate/github/pragmarb/pragma-rails.svg?maxAge=3600&style=flat-square)](https://codeclimate.com/github/pragmarb/pragma-rails)
-[![Coveralls](https://img.shields.io/coveralls/pragmarb/pragma-rails.svg?maxAge=3600&style=flat-square)](https://coveralls.io/github/pragmarb/pragma-rails)
+[![Build Status](https://travis-ci.org/pragmarb/pragma-rails.svg?branch=master)](https://travis-ci.org/pragmarb/pragma-rails)
+[![Dependency Status](https://gemnasium.com/badges/github.com/pragmarb/pragma-rails.svg)](https://gemnasium.com/github.com/pragmarb/pragma-rails)
+[![Coverage Status](https://coveralls.io/repos/github/pragmarb/pragma-rails/badge.svg?branch=master)](https://coveralls.io/github/pragmarb/pragma-rails?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e51e8d7489eb72ab97ba/maintainability)](https://codeclimate.com/github/pragmarb/pragma-rails/maintainability)
 
 This gem provides Ruby on Rails integration for the [Pragma](https://github.com/pragmarb/pragma) architecture.
 

data/lib/generators/pragma/resource_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pragma
-  class ResourceGenerator < ::Rails::Generators::NamedBase
+  class ResourceGenerator < ::Rails::Generators::NamedBase # :nodoc:
     source_root File.expand_path('../templates', __FILE__)
 
     class_option :version, type: :numeric, default: 1, desc: 'The API version to use', aliases: '-v'
@@ -15,25 +15,40 @@ module Pragma
 
     private
 
+    def namespaced_path
+      namespaced? ? super : ''
+    end
+
     def copy_resource_files
-      directory 'resource/resource', "app/resources/api/v#{options['version']}/#{file_name}"
+      directory(
+        'resource/resource',
+        "app/resources/#{namespaced_path}/api/v#{options['version']}/#{file_name}"
+      )
     end
 
     def copy_controller
-      template 'resource/controller.rb', "app/controllers/api/v#{options['version']}/#{file_name.pluralize}_controller.rb"
+      # rubocop:disable Metrics/LineLength
+      template(
+        'resource/controller.rb',
+        "app/controllers/#{namespaced_path}/api/v#{options['version']}/#{file_name.pluralize}_controller.rb"
+      )
+      # rubocop:enable Metrics/LineLength
     end
 
     def copy_spec
-      template 'resource/spec.rb', "spec/requests/api/v#{options['version']}/#{file_name.pluralize}_spec.rb"
+      template(
+        'resource/spec.rb',
+        "spec/requests/#{namespaced_path}/api/v#{options['version']}/#{file_name.pluralize}_spec.rb"
+      )
     end
 
-    def class_path
+    def route_path
       ['api', "v#{options['version']}"]
     end
 
     # Taken from https://github.com/rails/rails/blob/master/railties/lib/rails/generators/rails/resource_route/resource_route_generator.rb
     def generate_route
-      class_path.each_with_index do |namespace, index|
+      route_path.each_with_index do |namespace, index|
         write("namespace :#{namespace} do", index + 1)
       end
 
@@ -41,9 +56,14 @@ module Pragma
         ", path: '#{file_name.pluralize.tr('_', '-')}'"
       end
 
-      write("resources :#{file_name.pluralize}, only: %i(index show create update destroy)#{path_fragment}", route_length + 1)
+      # rubocop:disable Metrics/LineLength
+      write(
+        "resources :#{file_name.pluralize}, only: %i(index show create update destroy)#{path_fragment}",
+        route_length + 1
+      )
+      # rubocop:enable Metrics/LineLength
 
-      class_path.each_index do |index|
+      route_path.each_index do |index|
         write('end', route_length - index)
       end
 
@@ -62,7 +82,7 @@ module Pragma
     end
 
     def route_length
-      class_path.length
+      route_path.length
     end
   end
 end

data/lib/generators/pragma/templates/resource/controller.rb.tt

@@ -1,6 +1,8 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     class <%= file_name.pluralize.camelcase %>Controller < ResourceController
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/contract/base.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -8,3 +9,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/contract/create.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -8,3 +9,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/contract/update.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -8,3 +9,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/decorator/collection.rb.tt

@@ -1,11 +1,12 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
       module Decorator
         class Collection < Pragma::Decorator::Base
-          feature Pragma::Decorator::Type
-          feature Pragma::Decorator::Collection
-          feature Pragma::Decorator::Pagination
+          include Pragma::Decorator::Type
+          include Pragma::Decorator::Collection
+          include Pragma::Decorator::Pagination
 
           decorate_with Instance
         end
@@ -13,3 +14,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/decorator/instance.rb.tt

@@ -1,11 +1,13 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
       module Decorator
         class Instance < Pragma::Decorator::Base
-          feature Pragma::Decorator::Type
+          include Pragma::Decorator::Type
         end
       end
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/operation/create.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -8,3 +9,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/operation/destroy.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -8,3 +9,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/operation/index.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -8,3 +9,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/operation/show.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -8,3 +9,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/operation/update.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -8,3 +9,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/generators/pragma/templates/resource/resource/policy.rb.tt

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 module API
   module V<%= options['version'] %>
     module <%= file_name.camelcase %>
@@ -27,3 +28,4 @@ module API
     end
   end
 end
+<% end -%>

data/lib/pragma/rails/controller.rb

@@ -34,10 +34,7 @@ module Pragma
           if result['result.response'].entity
             render(
               status: result['result.response'].status,
-              json: result['result.response'].entity.to_json(user_options: {
-                expand: params[:expand],
-                current_user: operation_user
-              })
+              json: entity_to_hash(result['result.response'].entity).as_json
             )
           else
             head result['result.response'].status
@@ -63,6 +60,25 @@ module Pragma
         def operation_user
           current_user if respond_to?(:current_user)
         end
+
+        private
+
+        def entity_to_hash(entity)
+          options = {
+            user_options: {
+              expand: params[:expand],
+              current_user: operation_user
+            }
+          }
+
+          if entity.is_a?(Array)
+            entity.map { |e| entity_to_hash(e) }
+          elsif entity.respond_to?(:to_hash)
+            entity.method(:to_hash).arity.zero? ? entity.to_hash : entity.to_hash(options)
+          else
+            entity.as_json(options)
+          end
+        end
       end
     end
   end

data/lib/pragma/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Pragma
   module Rails
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

data/pragma-rails.gemspec

@@ -25,15 +25,15 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rails', '>= 4.2', '< 6'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec-rails'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'capybara'
-  spec.add_development_dependency 'factory_girl_rails'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'factory_girl_rails'
   spec.add_development_dependency 'faker'
   spec.add_development_dependency 'pry-rails'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pragma-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pragma
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,7 +115,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,7 +129,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: pry-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,7 +143,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl_rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -157,7 +157,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -171,7 +171,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -185,7 +185,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-rails
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -223,6 +223,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md