pragma-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88f74fb154bdd34d9c5a8a17a7c219a3c1b992c7
+  data.tar.gz: c6521f2f64a5d9df751a7d38b6dcd62e2758626e
+SHA512:
+  metadata.gz: d69736b9d80af68b5fd3abec80cadd9e92e3bcdada3d97a7c4b665ca3434602133d87acc6777bee886aca8914a5fb0357a7713f981b3923df86596704843ebea
+  data.tar.gz: 343bd16bd1fcd22997623fdce61998ad3fb21fa7c12b622393b4c4c8e072ab548e9c4eee71b4be249899bd8a080eac66f09b35635f5b777afd62ba961f0fe654

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/examples.txt

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,93 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'bin/*'
+   - 'db/**/*'
+   - 'vendor/bundle/**/*'
+   - 'spec/spec_helper.rb'
+   - 'spec/rails_helper.rb'
+   - 'spec/support/**/*'
+   - 'config/**/*'
+   - '**/Rakefile'
+   - '**/Gemfile'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/requests/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+
+Style/FirstParameterIndentation:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Style/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+RSpec/MessageExpectation:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.13.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pragma-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alessandro Desantis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# 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)
+
+This gem provides Ruby on Rails integration for the [Pragma](https://github.com/pragmarb/pragma) architecture.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pragma-rails'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install pragma-rails
+```
+
+## Usage
+
+All documentation is in the [doc](https://github.com/pragmarb/pragma-rails/tree/master/doc)
+folder.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pragmarb/pragma-rails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pragma/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pragma/rails.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'pragma'
+require 'rails'
+
+require 'pragma/rails/version'
+require 'pragma/rails/controller'
+require 'pragma/rails/resource_controller'
+
+module Pragma
+  # Ruby on Rails integration for the Pragma architecture.
+  #
+  # @author Alessandro Desantis
+  module Rails
+  end
+end

data/lib/pragma/rails/controller.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+module Pragma
+  module Rails
+    # This mixin should be included in a Rails controller to provide integration with Pragma
+    # operations.
+    #
+    # @author Alessandro Desantis
+    module Controller
+      def self.included(klass)
+        klass.include InstanceMethods
+      end
+
+      module InstanceMethods # :nodoc:
+        # Runs an operation, then responds with the returned status code, headers and resource.
+        #
+        # @param operation_klass [Class|String] a subclass of +Pragma::Operation::Base+
+        def run(operation_klass)
+          result = operation_klass.to_s.constantize.call(
+            params: operation_params,
+            current_user: operation_user
+          )
+
+          result.headers.each_pair do |key, value|
+            response.headers[key] = value
+          end
+
+          render status: result.status, json: result.resource.to_hash
+        end
+
+        protected
+
+        # Returns the parameters to pass to Pragma operations.
+        #
+        # By default, this is the +params+ hash.
+        #
+        # @return [Hash]
+        def operation_params
+          params
+        end
+
+        # Returns the currently authenticated user (for policies).
+        #
+        # By default, calls +current_user+ if the controller responds to it.
+        #
+        # @return [Object]
+        def operation_user
+          current_user if respond_to?(:current_user)
+        end
+      end
+    end
+  end
+end

data/lib/pragma/rails/resource_controller.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+module Pragma
+  module Rails
+    # Exposes CRUD operations on a resource through a Rails controller.
+    #
+    # @author Alessandro Desantis
+    module ResourceController
+      def self.included(klass)
+        klass.include Controller
+        klass.extend ClassMethods
+        klass.include InstanceMethods
+      end
+
+      module ClassMethods # :nodoc:
+        # Returns the expected class of the provided operation on this resource.
+        #
+        # Note that this does not mean the operation is actually supported. Use {#operation?} for
+        # that.
+        #
+        # @param operation_name [Symbol] name of the operation
+        #
+        # @return [String]
+        #
+        # @see #operation?
+        #
+        # @example
+        #   API::V1::PostsController.operation_klass(:create) => 'API::V1::Post::Operation::Create'
+        def operation_klass(operation_name)
+          [name.deconstantize].tap do |klass|
+            klass << name.demodulize.chomp('Controller').singularize
+            klass << "Operation::#{operation_name.to_s.camelize}"
+          end.join('::')
+        end
+
+        # Returns whether the provided operation is supported on this resource.
+        #
+        # @param operation_name [Symbol] name of the operation
+        #
+        # @return [Boolean]
+        def operation?(operation_name)
+          class_exists? operation_klass(operation_name)
+        end
+
+        private
+
+        def class_exists?(klass)
+          Object.const_get(klass)
+          true
+        rescue NameError
+          false
+        end
+      end
+
+      module InstanceMethods # :nodoc:
+        # If an action that does not exist is called on this controller, tries to find and run
+        # an operation on the current resource with the same name.
+        #
+        # For instance, +API::V1::PostsController#create+ would try to find and run
+        # +API::V1::Post::Operation::Create+.
+        #
+        # @param action_name [String] name of the missing action
+        def action_missing(action_name)
+          send(action_name)
+        end
+
+        # Supports running missing actions.
+        #
+        # @see #action_missing
+        def method_missing(method_name, *arguments, &block)
+          return super unless self.class.operation?(method_name)
+          run self.class.operation_klass(method_name)
+        end
+
+        # Supports running missing actions.
+        #
+        # @see #action_missing
+        def respond_to_missing?(method_name, include_private = false)
+          self.class.operation?(method_name) || super
+        end
+      end
+    end
+  end
+end

data/lib/pragma/rails/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Pragma
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/pragma-rails.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pragma/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pragma-rails'
+  spec.version       = Pragma::Rails::VERSION
+  spec.authors       = ['Alessandro Desantis']
+  spec.email         = ['desa.alessandro@gmail.com']
+
+  spec.summary       = 'Ruby on Rails integration for the Pragma architecture.'
+  spec.homepage      = 'https://github.com/pragmarb/pragma-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'pragma', '~> 0.1.0'
+  spec.add_dependency 'rails', '>= 4.2.0', '< 6'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: pragma-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pragma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- desa.alessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pragma/rails.rb
+- lib/pragma/rails/controller.rb
+- lib/pragma/rails/resource_controller.rb
+- lib/pragma/rails/version.rb
+- pragma-rails.gemspec
+homepage: https://github.com/pragmarb/pragma-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby on Rails integration for the Pragma architecture.
+test_files: []