resourceable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d30c0346ed98321cf31c90264b86017d3865abdabb2585d89060c9114e23b8a2
+  data.tar.gz: 74664ea69e227abf59e8e35be6c4ffa1b9fc8c4eb10bd8f4f6d6adc036b26b52
+SHA512:
+  metadata.gz: 693e6df52c761140523fb2362f705c91d2b4673e81c49b72c97a01fbe9eef611d2a758e09bfaabc762ff90136bcb215724c5ca4f44e9f8e15988755ba2e1af21
+  data.tar.gz: 1cf5c2e2b6dca62caf1b793d817feaf41128464f890e6536e9a8cdf42b1f3de160623936faf86308ad7fbe513afef34a7b6bff1d422222864746c541d1efd491

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jason Hazel
+
+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,126 @@
+# Resourceable
+Replaces the need for scaffolded controllers while not restricting the developer.
+
+## Live Stream
+
+I've been live streaming the creation of this gem over on [Twitch](http://twitch.tv/jasonhazel).  Videos are also posted to a [YouTube Playlist](https://www.youtube.com/playlist?list=PLi4UprHLU91BUYH1B5QMaRJnpP7vQzgu6)
+## Dependencies 
+
+* [CanCanCan](https://github.com/CanCanCommunity/cancancan) - loading and authorizing resource
+* [Ransack](https://github.com/activerecord-hackery/ransack)   - searching and sorting
+* [Kaminari](https://github.com/kaminari/kaminari)  - pagination
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resourceable'
+```
+
+
+## Usage
+
+Run the installer.  Resourceable will also run the installers for Kaminari, CanCan and Responders.
+
+```
+rails g resourceable:install
+```
+
+### CRUD 
+Replaces the need for scaffolded controller code.  You will still need too create the views (for now).
+
+```ruby 
+class UsersController < ApplicationController 
+  crud permitted: [ # strong params (default to {})
+    :email, :password 
+    ], 
+    cancan: { # cancan options (default is cancan default)
+      class_name: User, 
+      id_params: :user_id 
+    },
+    q: :search # ransack url variable (defaults to :q)
+end
+```
+
+Strong params can be defined in an instance method named `resource_params`
+
+```ruby 
+class UsersController < ApplicationController 
+  crud
+
+  private 
+
+  def resource_params 
+    params.require(:user).permit(:email, :password)
+  end
+end
+
+```
+
+And of the regular CRUD actions can be done as one normally would.  If you need some custom handling of resource creation, just define it. Resourceable will still handle any actions you haven't defined.
+
+```ruby 
+class UsersController < ApplicationController 
+  crud permitted: [:email, :password]
+
+  def create 
+    if @user.valid?
+      @user.save 
+      UserMailer.new_user(@user).deliver_now
+    else 
+      render :new
+    end
+  end
+end
+
+```
+
+### Pagination 
+
+Pagination can be configured through the `pagination` option. Everything else is just plain Kaminari.
+
+
+```ruby 
+class UsersController < ApplicationController 
+  crud pagination: {
+      param: :user_page,  # default is :page, 
+      per: 10,            # default is 20
+    }
+end
+```
+
+### SimpleForm Inputs 
+
+#### has_many 
+
+Resourceable adds a new SimpleForm input of `has_many` to simplify `has_many` associations. Resourceable will use the provided partial to display the associated objects. Don't forget to update the `permitted` params in your controller for the nested attributes.
+
+```ruby 
+class Task < ApplicationRecord 
+  has_many :details 
+  accepts_nested_attributes_for :details
+end
+
+class Detail < ApplicationRecord 
+  belongs_to :task
+end
+
+```
+
+```slim 
+/ app/views/tasks/_form.slim
+= simple_form_for @task do |f|
+  = f.input :details, as: :has_many, partial: 'tasks/detail_fields'
+```
+
+```slim 
+/ app/views/tasks/_detail_fields.slim
+= form_object.input :body
+```
+
+
+## Contributing
+Contribution directions go here.
+
+## 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,33 @@
+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    = 'Resourceable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/resourceable/install_generator.rb

@@ -0,0 +1,28 @@
+module Resourceable 
+  module Generators 
+    class InstallGenerator < Rails::Generators::Base 
+      # TODO: add options for the various generators
+      # things like using bootstrap themes for simple_form or kaminari
+      def responders 
+        generate 'responders:install'
+      end
+
+      def cancan
+        generate 'cancan:ability'
+      end
+
+      def kaminari 
+        generate 'kaminari:config'
+        generate 'kaminari:views -e slim'
+      end
+
+      def simple_form 
+        generate 'simple_form:install'
+
+        inject_into_file 'config/initializers/simple_form.rb', after: '  # config.custom_inputs_namespaces << "CustomInputs"' do 
+          "\n\tconfig.custom_inputs_namespaces << 'Resourceable::Inputs'"
+        end
+      end
+    end
+  end
+end

data/lib/generators/resourceable/resource_generator.rb

@@ -0,0 +1,41 @@
+module Resourceable 
+  module Generators 
+    class ResourceGenerator < Rails::Generators::NamedBase 
+      # rails g resourceable:resource User email:string password:string
+
+      class_option :attributes, type: :hash, banner: 'hash of model attributes', aliases: ['-a']
+
+      def model
+        generate 'model', "#{name} #{attributes_cli_options}"
+      end
+
+      def controller 
+        generate 'controller', name.titleize.pluralize
+        
+        puts "app/controllers/#{name.downcase.pluralize}_coontroller.rb"
+        puts "#{name.titleize.pluralize}Controller"
+
+        inject_into_class controller_path, controller_name, 
+          "\tcrud permitted: #{attribute_keys}\n"    
+      end
+
+      private 
+
+      def attributes_cli_options
+        options[:attributes].map{ |k,v| "#{k}:#{v}" }.join(' ')
+      end
+
+      def attribute_keys
+        options[:attributes].symbolize_keys.keys
+      end
+
+      def controller_name 
+        "#{name.titleize.pluralize}Controller" 
+      end
+
+      def controller_path
+        "app/controllers/#{name.downcase.pluralize}_controller.rb"
+      end
+    end
+  end
+end

data/lib/resourceable.rb

@@ -0,0 +1,22 @@
+
+# third party 
+require 'slim'
+require 'cancancan'
+require 'ransack'
+require 'kaminari'
+require 'responders'
+require 'simple_form'
+
+# patches
+require 'resourceable/patches/cancan'
+
+# our files
+require 'resourceable/controllers/crud'
+require 'resourceable/models/form_builder'
+
+# simple_form inputs 
+require 'resourceable/inputs/has_many'
+
+module Resourceable
+  
+end

data/lib/resourceable/controllers/crud.rb

@@ -0,0 +1,115 @@
+module Resourceable 
+  module Controllers
+    module CRUD
+      extend ActiveSupport::Concern 
+
+      module ClassMethods 
+        def crud(options = {})
+          cattr_accessor :strong_params
+          cattr_accessor :cancan_options
+          cattr_accessor :search_param
+          cattr_accessor :pagination_params
+          
+          self.strong_params      = options.fetch(:permitted, [])
+          self.cancan_options     = options.fetch(:cancan, {})
+          self.search_param       = options.fetch(:q, :q)
+          self.pagination_params  = pagination_defaults.merge(options.fetch(:pagination, {}))
+          
+
+          include Resourceable::Controllers::CRUD::InstanceMethods
+        end
+
+        private 
+
+        def pagination_defaults 
+          { param: :page, per: 20 }
+        end
+      end
+      
+      module InstanceMethods 
+        extend ActiveSupport::Concern 
+
+        included do 
+          respond_to :html, :json
+
+          load_and_authorize_resource self.cancan_options
+        end
+
+        with_options to: :cancan_resource, prefix: false do |controller|
+          controller.delegate :collection_instance, :collection_instance=, 
+                              :resource_instance, :resource_instance=,
+                              :instance_name
+        end
+        
+        def index 
+          @search = collection_instance.search(search_params)
+          collection_instance! @search.result.page(page_params).per(pagination.per)
+          respond_with collection_instance
+        end 
+
+        def show 
+        end
+
+        def new 
+        end 
+
+        def create 
+          resource_instance.save
+          respond_with resource_instance
+        end 
+
+        def edit 
+        end 
+
+        def update 
+          resource_instance.update_attributes(resource_params) 
+          respond_with resource_instance
+        end 
+
+        def destroy
+          resource_instance.destroy 
+          respond_with resource_instance
+        end
+
+        private 
+
+        def flash_interpolation_options
+          { resource_name: resource_instance.class.to_s }
+        end
+
+        def page_params 
+          params.fetch(pagination.param, nil)
+        end
+
+        def search_params 
+          params.fetch(self.class.search_param, {})
+        end
+
+        def resource_params 
+          params.require(instance_name.to_sym).permit(self.class.strong_params)
+        end
+
+        def pagination 
+          OpenStruct.new(self.class.pagination_params)
+        end
+
+        protected 
+
+        def cancan_resource 
+          @cancan ||= self.class.cancan_resource_class.new(self)
+        end
+
+        def collection_instance!(collection)
+          send(:collection_instance=, collection)
+        end
+
+        def resource_instance!(resource)
+          send(:resource_instance=, resource)
+        end
+
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, Resourceable::Controllers::CRUD

data/lib/resourceable/inputs/has_many.rb

@@ -0,0 +1,34 @@
+module Resourceable  
+  # simple_form might not play nice with namespaced inputs, we'll find out.
+  module Inputs
+    class HasManyInput < SimpleForm::Inputs::Base 
+      def input 
+        unless partial 
+          # TODO: Implement proper exceptions.
+          raise 'You must specify a partial for `has_many` inputs.'
+        end
+        output = ActiveSupport::SafeBuffer.new 
+
+        output << @builder.simple_fields_for(attribute_name )do |ff|
+          ff.input(:id, as: :hidden) + build_inputs(ff)
+        end
+
+        output
+      end
+
+      private 
+
+      def partial 
+        options.fetch(:partial, nil)
+      end
+
+      def action_view 
+        @action_view ||= ActionView::Base.new(ActionController::Base.view_paths, {})
+      end
+
+      def build_inputs(form_object)
+        action_view.render(partial: partial, locals: { form_object: form_object }).html_safe
+      end
+    end
+  end
+end

data/lib/resourceable/models/form_builder.rb

@@ -0,0 +1,42 @@
+module Resourceable 
+  module Models 
+    module FormBuilder 
+      extend ActiveSupport::Concern
+
+      module ClassMethods 
+        def skip_input(*attributes)
+          cattr_accessor :skipped_inputs 
+          self.skipped_inputs = (attributes || []).map(&:to_sym)
+
+          include_once Resourceable::Models::FormBuilder::InstanceMethods
+        end
+
+        def hidden_inputs(*attributes)
+
+        end
+
+        private 
+
+        def include_once(module_name)
+          unless self.included_modules.include?(module_name)
+            include module_name 
+          end
+        end
+      end
+
+      module InstanceMethods 
+        extend ActiveSupport::Concern
+
+        def skipped_inputs
+          self.class.skipped_inputs
+        end
+
+        def skipped_input?(attribute_name)
+          skipped_inputs.include?(attribute_name.to_sym)
+        end
+      end
+    end 
+  end
+end
+
+ActiveRecord::Base.send :include, Resourceable::Models::FormBuilder

data/lib/resourceable/patches/cancan.rb

@@ -0,0 +1,11 @@
+module CanCan
+  class ControllerResource
+    # TODO: make this less stupid, there has to be a better way than just making the methods public
+
+    public :collection_instance
+    public :collection_instance= 
+    public :resource_instance 
+    public :resource_instance=
+    public :instance_name
+  end
+end

data/lib/resourceable/version.rb

@@ -0,0 +1,3 @@
+module Resourceable
+  VERSION = '0.1.0'
+end

data/lib/tasks/resourceable_tasks.rake

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

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: resourceable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Hazel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  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: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Better than scaffolds
+email:
+- jason@hazel.codes
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/resourceable/install_generator.rb
+- lib/generators/resourceable/resource_generator.rb
+- lib/resourceable.rb
+- lib/resourceable/controllers/crud.rb
+- lib/resourceable/inputs/has_many.rb
+- lib/resourceable/models/form_builder.rb
+- lib/resourceable/patches/cancan.rb
+- lib/resourceable/version.rb
+- lib/tasks/resourceable_tasks.rake
+homepage: https://github.com/jasonhazel/resourceable
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Simplify CRUD
+test_files: []