natural_resource 0.1.2.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 471019cc52094c5009a4aca80d8a7410f92194f9
+  data.tar.gz: dffd007f8763759da6b7449f7f527f49b32dac6f
+SHA512:
+  metadata.gz: 14f3e5cf9c857ee1a5dd91e0720924533fa91ff92b97715d22419901555d6833e9953b8174f2f4dc45648113c53973e82ddb17a5fe26755f134688f18ee2f1f0
+  data.tar.gz: 2ec45e30ef95b9699defecf3b5014bcf04d8ccd3ccba095ef9aaeb41ea2ef6fa26332a54d285dace3aa14f43cd2be8108279c603933a2f3a457900036919ddae

data/README.md

@@ -0,0 +1,39 @@
+# Natural Resource
+
+<img src="http://www.terracoding.com/assets/images/natural-resource.png" alt="Logo" height="200px"/>
+
+Natural Resource is a small but opinionated framework built ontop of some of our favourite gems. It is designed to speed up CRUD related activities whilst still maintaining sensible standards (e.g. Admin Panel, expandable principles for an API). It utilises [Pundit](https://github.com/elabs/pundit) for authorisation and [Ransack](https://github.com/activerecord-hackery/ransack) for searching and filtering.
+
+Sponsored by [Terracoding](http://terracoding.com)
+
+# Getting Started
+
+Simply install the gem
+
+``` ruby
+  gem 'natural_resource'
+```
+Setup the Base Policy:
+``` sh
+rails g natural:install
+```
+
+Then generate controllers/policies as required:
+
+``` sh
+rails g natural:resource controller_name optional_model_name
+```
+
+The overall codebase for NaturalResource is very small and the bulk of the functionality can be found in `lib/natural_resource/controller.rb`, it's all relatively simple ruby code designed to be expanded on top for any custom functionality. To understand how Pundit works I suggest visiting their repository and going through the basics.
+
+# Contributing
+
+All contributions are welcome, simply fork the project and make a Pull Request upstream.
+
+# Testing
+
+Simply run the `rspec` test suite from the `spec/dummy` folder.
+
+# License
+
+Licensed under the MIT license, see the separate MIT-LICENSE.txt file.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NaturalResource'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/natural/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Install the dependencies for using NaturalResource
+
+Example:
+    rails generate natural:install
+
+    This will create:
+      app/policies/application_policy.rb
+

data/lib/generators/natural/install/install_generator.rb

@@ -0,0 +1,9 @@
+require 'rails/generators'
+
+class Natural::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_application_policy
+    template 'application_policy.rb', 'app/policies/application_policy.rb'
+  end
+end

data/lib/generators/natural/install/templates/application_policy.rb

@@ -0,0 +1,24 @@
+class ApplicationPolicy < NaturalResource::Policy
+  class Scope < Scope
+    # It is recommended to use per-role scopes for Users # simply extend the
+    # resolve method with conditions for each "role" and the name of the scope
+    # they should call.
+    def resolve
+      if !user.is_a? User
+        anon_user_scope
+      else
+        standard_user_scope
+      end
+    end
+
+    def standard_user_scope
+      scope
+      # scope.where(user: user) # e.g. only show resources that belong to that user
+    end
+
+    def anon_user_scope
+      scope
+      # scope.public # e.g. only display public data
+    end
+  end
+end

data/lib/generators/natural/resource/USAGE

@@ -0,0 +1,17 @@
+Description:
+  Generator to generate a natural_resource controller and it's dependencies.
+  Can be called via controller_name and with or without the model (inferred without).
+
+Example:
+    rails generate natural:resource controller_name policy_model_name
+
+    This will create:
+      app/controllers/#{controller_name}.rb
+      app/policies/#{model_name}_policy.rb
+
+    rails generate natural:resource controller_name
+
+    This will create:
+      app/controllers/#{controller_name}.rb
+      app/policies/#{controller_name.singularize}_policy.rb
+

data/lib/generators/natural/resource/resource_generator.rb

@@ -0,0 +1,29 @@
+require 'pundit'
+require 'rails/generators'
+
+class Natural::ResourceGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :model_name, type: :string, default: ''
+
+  def generate_dependencies
+    @model_name = name if @model_name.blank?
+    invoke 'pundit:policy', [@model_name.singularize]
+    invoke 'controller', [name.pluralize]
+
+    c_sentinel = '< ApplicationController'
+
+    # Add resource reference to generated controller
+    in_root do
+      gsub_file "app/controllers/#{name.pluralize}_controller.rb", /(#{Regexp.escape(c_sentinel)})/mi do |match|
+        "#{match}\n  resource :#{@model_name.pluralize.downcase}\n\n  def resource_params\n    params.require(:#{@model_name.singularize}).permit()\n  end\n"
+      end
+    end
+
+    # Add note to generated Pundit policy
+    in_root do
+      gsub_file "app/policies/#{@model_name.singularize}_policy.rb", /(def resolve\n\s+scope\n\s+end)/mi do |match|
+        '# See ApplicationPolicy.rb to see how a scope is defined and used'
+      end
+    end
+  end
+end

data/lib/generators/natural.rb

@@ -0,0 +1,3 @@
+module Natural
+
+end

data/lib/generators/rspec/policy_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class PolicyGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_policy_spec
+        template 'policy_spec.rb', File.join('spec/policies', class_path, "#{file_name}_policy_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/policy_spec.rb

@@ -0,0 +1,28 @@
+require '<%= File.exists?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>'
+
+describe <%= class_name %>Policy do
+  let(:model) { } # <%= class_name %>.new
+  subject { described_class.new(user, model)  }
+
+  context 'when a standard user' do
+    let(:user) { User.new }
+
+    # it { is_expected.to permit_auth(:action) }
+  end
+
+  context 'when an anon user' do
+    let(:user) { User.new }
+
+    # it { is_expected.to_not permit_auth(:action) }
+  end
+
+  describe <%= class_name %>Policy::Scope do
+    context 'when a standard user' do
+      let(:user) { } # User.new
+    end
+
+    context 'when a anon user' do
+      let(:user) { nil }
+    end
+  end
+end

data/lib/natural_resource/controller.rb

@@ -0,0 +1,93 @@
+require 'active_support/concern'
+require 'action_controller'
+require 'pundit'
+require 'ransack'
+require 'will_paginate'
+
+module NaturalResource
+  module Controller
+    extend ActiveSupport::Concern
+    include Pundit
+
+    class_methods do
+      def resource(resource_name)
+        after_action :verify_authorized, except: :index
+        after_action :verify_policy_scoped
+
+        helper_method :current_context, :query, :resource_class, :resource, :resources
+
+        rescue_from ActiveRecord::RecordInvalid, with: :handle_invalid_create_or_update
+
+        # GET /:controller_name/new
+        define_method :new do; end
+
+        # GET /:controller_name/edit
+        define_method :edit do; end
+
+        # GET /:controller_name
+        define_method :index do; end
+
+        # POST /:controller_name
+        define_method :create do
+          resource.update! resource_params
+          redirect_to success_path, {notice: "#{resource} was created."}
+        end
+
+        # PUT /:controller_name/:id
+        define_method :update do
+          resource.tap { |r| r.update! resource_params }.touch
+          redirect_to success_path, {notice: "#{resource} was updated."}
+        end
+
+        # DELETE /:controller_name/:id
+        define_method :destroy do
+          resource.destroy
+          redirect_to success_path, {notice: "#{resource} was deleted."}
+        end
+
+        private
+
+        define_method :current_context do; end
+
+        # Resource allocation methods
+        define_method :query do
+          @query ||= policy_scope(resource_scope).ransack(params[:q])
+        end
+
+        define_method :resource_class do
+          resource_name.to_s.singularize.camelcase.constantize
+        end
+
+        define_method :resource do
+          @resource ||= if ['new', 'create'].include?(action_name)
+                          policy_scope(resource_scope).new
+                        else
+                          policy_scope(resource_scope).find(params[:id])
+                        end.tap(&method(:authorize))
+        end
+
+        define_method :resources do
+          @resources ||= query.result.paginate(page: params[:page])
+        end
+
+        define_method :resource_scope do
+          resource_class
+        end
+
+        define_method :success_path do
+          url_for(action: :index)
+        end
+      end
+    end
+
+    def handle_invalid_create_or_update
+      case action_name
+      when 'create' then render :new
+      when 'update' then render :edit
+      else raise NotImplementedError
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, NaturalResource::Controller

data/lib/natural_resource/core_ext.rb

@@ -0,0 +1,5 @@
+String.class_eval do
+  def to_squawk
+    "squawk! #{self}".strip
+  end
+end

data/lib/natural_resource/policy.rb

@@ -0,0 +1,95 @@
+require 'set'
+require 'natural_resource/policy_preconditions'
+
+# Starting block for ApplicationPolicy, set up for easy overriding
+module NaturalResource
+  class Policy
+    include NaturalResource::PolicyPreconditions
+    attr_reader :user, :record
+
+    def initialize(user, record)
+      @user = user
+      @record = record
+      @errors = Hash.new { |h,k| h[k]= Set.new([]) }
+      @failure_status = nil
+    end
+
+    def failure_status
+      @failure_status.presence || :unauthorized
+    end
+
+    def errors
+      if @errors.keys.empty?
+        {user: ['does not have permission to perform this action']}
+      else
+        @errors
+      end
+    end
+
+    def index?
+      false
+    end
+
+    def show?
+      scope.where(id: record.id).exists?
+    end
+
+    def create?
+      false
+    end
+
+    def new?
+      create?
+    end
+
+    def update?
+      false
+    end
+
+    def edit?
+      update?
+    end
+
+    def destroy?
+      false
+    end
+
+    def own_record?
+      user && record.user == user
+    end
+
+    def anon?
+      user.nil?
+    end
+
+    def scope
+      Pundit.policy_scope!(user, record.class)
+    end
+
+    # Base Scope class to infer/scope what a user should see
+    class Scope
+      attr_reader :user, :scope
+
+      def initialize(user, scope)
+        @user = user
+        @scope = scope
+      end
+
+      def resolve
+        if !user.is_a?(User)
+          anon_user_scope
+        else
+          standard_user_scope
+        end
+      end
+
+      def standard_user_scope
+        raise NotImplementedError, [self.class.name, __method__].join('#')
+      end
+
+      def anon_user_scope
+        raise NotImplementedError, [self.class.name, __method__].join('#')
+      end
+    end
+  end
+end

data/lib/natural_resource/policy_preconditions.rb

@@ -0,0 +1,22 @@
+# Encapsulation/Separation of precondition logic for Pundit policies
+module NaturalResource::PolicyPreconditions
+  private
+
+  def precondition(record, precondition=nil, identifier: nil, message: nil)
+    precondition_met = if block_given?
+                       yield
+                     else
+                       record.public_send(precondition)
+                     end
+
+    identifier ||= record.class.to_s.underscore
+    message ||= "is not #{precondition.to_s.gsub(/\?*$/, '')}"
+
+    unless precondition_met
+      @failure_status ||= :precondition_failed
+      @errors[identifier] << message
+    end
+
+    precondition_met
+  end
+end

data/lib/natural_resource/railtie.rb

@@ -0,0 +1,7 @@
+module NaturalResource
+  class Railtie < Rails::Railtie
+    config.app_generators do |g|
+      g.templates.unshit File::expand_path('../../templates', __FILE__)
+    end
+  end
+end

data/lib/natural_resource/version.rb

@@ -0,0 +1,3 @@
+module NaturalResource
+  VERSION = "0.1.2.pre"
+end

data/lib/natural_resource.rb

@@ -0,0 +1,9 @@
+require 'natural_resource/version'
+require 'natural_resource/controller'
+require 'natural_resource/policy'
+require 'generators/natural'
+require 'generators/natural/resource/resource_generator'
+require 'generators/natural/install/install_generator'
+
+module NaturalResource
+end

data/lib/tasks/natural_resource_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :natural_resource do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: natural_resource
+version: !ruby/object:Gem::Version
+  version: 0.1.2.pre
+platform: ruby
+authors:
+- Robert White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- robert@terracoding.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/generators/natural.rb
+- lib/generators/natural/install/USAGE
+- lib/generators/natural/install/install_generator.rb
+- lib/generators/natural/install/templates/application_policy.rb
+- lib/generators/natural/resource/USAGE
+- lib/generators/natural/resource/resource_generator.rb
+- lib/generators/rspec/policy_generator.rb
+- lib/generators/rspec/templates/policy_spec.rb
+- lib/natural_resource.rb
+- lib/natural_resource/controller.rb
+- lib/natural_resource/core_ext.rb
+- lib/natural_resource/policy.rb
+- lib/natural_resource/policy_preconditions.rb
+- lib/natural_resource/railtie.rb
+- lib/natural_resource/version.rb
+- lib/tasks/natural_resource_tasks.rake
+homepage: http://www.github.com/haar/natural_resource
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Small Rails Framework to speed up CRUD controllers
+test_files: []