action_crud 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 239ccd1fb5a941484a62505a460d63a908ef14d2
+  data.tar.gz: 71a5a0f71c1b84af387dfc2183daf83cd9847f53
+SHA512:
+  metadata.gz: dc062dc715d3ffaac8504f24ef5a9317b80c11401cac64ad6d34f5b152d371c37ddc9e2d68dd85ac71dd17e0d9fcf6a791edfa5cea6f8d0e55cea744c63fe114
+  data.tar.gz: 779ce72b7c8f914ff9ca673f6ae1e2f251d0ceb3e4e59f132a0cf91d8253b16dd3f77083acf3d75239238b89d1befe424b3aa512c4433afaf79ab875e493d128

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    action_crud (0.1.0)
+      actionpack (~> 5.0)
+      i18n (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.2)
+    erubi (1.6.1)
+    i18n (0.8.6)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action_crud!
+  bundler (~> 1.14)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonian Guveli
+
+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,99 @@
+# ActionCrud
+
+ActionCrud speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important. It makes your controllers more powerful and cleaner at the same time. In addition to making your controllers follow a pattern, it helps you to write better code by following fat models and skinny controllers convention.
+
+[![Gem Version](https://badge.fury.io/rb/action_crud.svg)](https://badge.fury.io/rb/action_crud)
+[![Build Status](https://travis-ci.org/hardpixel/action-crud.svg?branch=master)](https://travis-ci.org/hardpixel/action-crud)
+[![Code Climate](https://codeclimate.com/github/hardpixel/action-crud/badges/gpa.png)](https://codeclimate.com/github/hardpixel/aaction-crud)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_crud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_crud
+
+## Usage
+
+To enable CRUD actions in an ActionController controller, include the `ActionCrud` concern in your class:
+
+```ruby
+class Post < ActionController::Base
+  include ActionCrud
+end
+```
+
+To set the controller model, use the `set_model_name` function:
+
+```ruby
+class Post < ActionController::Base
+  # Using the set_model_name function
+  set_model_name 'Post'
+
+  # Or by setting the model_name class attribute
+  self.model_name = 'Post'
+end
+```
+
+To set a scope for the index action, use the `set_index_scope` function:
+
+```ruby
+class Post < ActionController::Base
+  # Using the set_index_scope function
+  set_index_scope :published
+
+  # Or by setting the model_name class attribute
+  self.index_scope = :published
+end
+```
+
+To set the permitted parameters for the controller, use the `permit_params` function. The function accepts the options `only`, `except`, `also`, `array`, `hash`. Array and hash options are used to indicate array and hash parameters. If you call the function without options it will permit all the model attribute names except `id`:
+
+```ruby
+class Post < ActionController::Base
+  # Using the permit_params function
+  permit_params only: [:title, :content], array: [:categories, :tags]
+
+  # Or by setting the permitted_params class attribute
+  self.permitted_params = [:title, :content, [categories: []], [tags: []]]
+
+  private
+
+    # Or by overriding the record_params function
+    def record_params
+      params.require(:post).permit(:title, :content, [categories: []], [tags: []])
+    end
+end
+```
+
+After setting up the controller, like the examples above, you will have a fully working CRUD controller with instance variables `@post` and `@posts` available. Also, if you use a pagination gem like [SmartPagination](https://github.com/hardpixel/smart-pagination), the index records will be automagically paginated!
+
+ActionCrud also injects in your views and controllers the following helpers:
+
+| Paths              | URLs             | Data               | Tags (views only) |
+| :----------------- | :--------------- | :----------------- | :---------------- |
+| `records_path`     | `records_url`    | `current_model`    | `record_link_to`  |
+| `record_path`      | `record_url`     | `current_record`   | `record_links_to` |
+| `new_record_path`  | `new_record_url` | `current_records`  | &nbsp;            |
+| `edit_record_path` | `edit_record_url`| `permitted_params` | &nbsp;            |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/action-crud.
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/action_crud.rb

@@ -0,0 +1,28 @@
+require 'action_crud/controller'
+require 'action_crud/pagination'
+require 'action_crud/helpers/route'
+require 'action_crud/helpers/link'
+require 'action_crud/helpers/url'
+require 'action_crud/helpers/view'
+require 'action_crud/version'
+
+module ActionCrud
+  extend ActiveSupport::Concern
+
+  included do
+    # Include submodules
+    include ActionCrud::Controller
+    include ActionCrud::Pagination
+  end
+end
+
+# Include action view helpers
+if defined? ActionView::Base
+  ActionView::Base.send :include, ActionCrud::Helpers::Url
+  ActionView::Base.send :include, ActionCrud::Helpers::View
+end
+
+# Include action controller helpers
+if defined? ActionController::Base
+  ActionController::Base.send :include, ActionCrud::Helpers::Url
+end

data/lib/action_crud/controller.rb

@@ -0,0 +1,174 @@
+module ActionCrud
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      # Class attributes
+      class_attribute :model_name,       instance_predicate: false
+      class_attribute :index_scope,      instance_predicate: false
+      class_attribute :permitted_params, instance_predicate: false
+
+      # Class attributes defaults
+      self.model_name       = self.controller_name
+      self.index_scope      = :all
+      self.permitted_params = []
+
+      # Action callbacks
+      before_action :set_record, only: [:show, :edit, :update, :destroy]
+    end
+
+    class_methods do
+      # Set permitted parameters
+      def permit_params(options={})
+        model   = self.model_name.classify.constantize
+        default = { only: model.attribute_names, except: [], also: [], array: [], hash: [] }
+        options = Hash[default.merge(options).map { |k, v| [k, Array(v).map(&:to_sym)] }]
+        permit  = options.except(:except).values.flatten.uniq
+
+        permit.reject! { |a| a.blank? || a.in?(options[:except] + [:id]) }
+        permit.map!    { |a| a.in?(options[:array]) ? [a => []] : a }
+        permit.map!    { |a| a.in?(options[:hash])  ? [a => {}] : a }
+
+        self.permitted_params = permit
+      end
+
+      # Set model name
+      def set_model_name(name)
+        self.model_name = name
+      end
+
+      # Set index scope
+      def set_index_scope(scope)
+        self.index_scope = scope
+      end
+    end
+
+    # GET /model
+    def index
+      self.records = model.send self.index_scope
+      self.records = paginate(records) if respond_to? :per_page
+
+      respond_to do |format|
+        format.html { render :index }
+        format.json { render json: records }
+      end
+    end
+
+    # GET /model/new
+    def new
+      self.record = model.new
+
+      respond_to do |format|
+        format.html { render :new }
+        format.json { render json: record }
+      end
+    end
+
+    # GET /model/1
+    def show
+      respond_to do |format|
+        format.html { render :show }
+        format.json { render json: record }
+      end
+    end
+
+    # GET /model/1/edit
+    def edit
+      respond_to do |format|
+        format.html { render :edit }
+        format.json { render json: record }
+      end
+    end
+
+    # POST /model
+    def create
+      self.record = model.new(record_params)
+
+      respond_to do |format|
+        if record.save
+          format.html { redirect_to edit_record_path(record), notice: "#{model} was successfully created." }
+          format.json { render json: record, status: :created }
+        else
+          format.html { render :new }
+          format.json { render json: record.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PATCH/PUT /model/1
+    def update
+      respond_to do |format|
+        if record.update(record_params)
+          format.html { redirect_to edit_record_path(record), notice: "#{model} was successfully updated." }
+          format.json { render json: record, status: :ok }
+        else
+          format.html { render :edit }
+          format.json { render json: record.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /model/1
+    def destroy
+      record.destroy
+
+      respond_to do |format|
+        format.html { redirect_to records_path, notice: "#{model} was successfully destroyed." }
+        format.json { head :no_content }
+      end
+    end
+
+    # Get model
+    def model
+      model_name.classify.constantize
+    end
+
+    alias :current_model :model
+
+    # Get single record
+    def record
+      instance_variable_get "@#{singular_name}"
+    end
+
+    alias :current_record :record
+
+    # Get records collection
+    def records
+      instance_variable_get "@#{plural_name}"
+    end
+
+    alias :current_records :records
+
+    private
+
+      # Get singular name
+      def singular_name
+        model_name.demodulize.singularize
+      end
+
+      # Get plural name
+      def plural_name
+        model_name.demodulize.pluralize
+      end
+
+      # Set single record
+      def record=(value)
+        instance_variable_set "@#{singular_name}", value
+      end
+
+      # Set records collection
+      def records=(value)
+        instance_variable_set "@#{plural_name}", value
+      end
+
+      # Use callbacks to share common setup or constraints between actions.
+      def set_record
+        self.record = model.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def record_params
+        params.require(:"#{singular_name}").permit self.permitted_params
+      end
+  end
+end

data/lib/action_crud/helpers/link.rb

@@ -0,0 +1,54 @@
+module ActionCrud
+  module Helpers
+    class Link
+      attr_accessor :record, :action, :label, :options
+
+      # Initialize link generator
+      def initialize(context, record=nil, action=nil, *args)
+        @options = args.extract_options!
+        @context = context
+        @record  = record || @context.try(:current_record)
+        @action  = action
+        @label   = options.fetch :label, nil
+        @options = options.except :label
+
+        if delete?
+          @options.reverse_merge!(method: :delete, data: { confirm: 'Are you sure?' })
+        end
+      end
+
+      # Is delete action
+      def delete?
+        action.in? [:delete, :destroy]
+      end
+
+      # Get link label
+      def action_label
+        label || "#{action}".humanize
+      end
+
+      # Get record path
+      def record_path
+        ActionCrud::Helpers::Route.new(@context, record, action).path || "#{action}"
+      end
+
+      # Render multiple
+      def render_multiple(*args)
+        default = options
+        options = args.extract_options!
+        actions = args.concat(action).concat(options.keys)
+        links   = actions.uniq.map do |item|
+          args = Hash(options[item]).reverse_merge(default)
+          ActionCrud::Helpers::Link.new(@context, record, item, args).render
+        end
+
+        links.join.html_safe
+      end
+
+      # Render link
+      def render
+        @context.link_to action_label, record_path, options if record_path.present?
+      end
+    end
+  end
+end

data/lib/action_crud/helpers/route.rb

@@ -0,0 +1,53 @@
+module ActionCrud
+  module Helpers
+    class Route
+      attr_accessor :record, :action, :options, :path, :url
+
+      # Intialize url finder
+      def initialize(context, record=nil, action=nil, *options)
+        @context = context
+        @record  = record || @context.try(:current_record)
+        @action  = action
+        @options = options
+        @path    = route_uri :path
+        @url     = route_uri :url
+      end
+
+      # To string
+      def to_s(type=:path)
+        instance_variable_get("@#{type}").to_s
+      end
+
+      # Is index action
+      def index?
+        action == :index
+      end
+
+      # Should prefix method
+      def prefix?
+        action.in? [:new, :edit]
+      end
+
+      # Should include record
+      def record?
+        action.in? [:show, :edit, :delete, :destroy]
+      end
+
+      # Find route key
+      def route_key
+        singular = 'singular_' unless index?
+        record.model_name.try :"#{singular}route_key"
+      end
+
+      # Find route method
+      def route_uri(type)
+        args   = [*options]
+        args   = [record, *options] if record?
+        method = "#{route_key}_#{type}"
+        method = "#{action}_#{method}" if prefix?
+
+        @context.try :"#{method}", *args
+      end
+    end
+  end
+end

data/lib/action_crud/helpers/url.rb

@@ -0,0 +1,69 @@
+module ActionCrud
+  module Helpers
+    module Url
+      # Get record path
+      def record_path(*args)
+        options = args.extract_options!
+        record  = args.first
+
+        ActionCrud::Helpers::Route.new(self, record, :show, options).path
+      end
+
+      # Get record absolute url
+      def record_url(*args)
+        options = args.extract_options!
+        record  = args.first
+
+        ActionCrud::Helpers::Route.new(self, record, :show, options).url
+      end
+
+      # Get records index path
+      def records_path(*args)
+        options = args.extract_options!
+        record  = args.first
+
+        ActionCrud::Helpers::Route.new(self, record, :index, options).path
+      end
+
+      # Get records index absolute url
+      def records_url(*args)
+        options = args.extract_options!
+        record  = args.first
+
+        ActionCrud::Helpers::Route.new(self, record, :index, options).url
+      end
+
+      # Get record new path
+      def new_record_path(*args)
+        options = args.extract_options!
+        record  = args.first
+
+        ActionCrud::Helpers::Route.new(self, record, :new, options).path
+      end
+
+      # Get record new absolute url
+      def new_record_url(*args)
+        options = args.extract_options!
+        record  = args.first
+
+        ActionCrud::Helpers::Route.new(self, record, :new, options).url
+      end
+
+      # Get record edit path
+      def edit_record_path(*args)
+        options = args.extract_options!
+        record  = args.first
+
+        ActionCrud::Helpers::Route.new(self, record, :edit, options).path
+      end
+
+      # Get record edit absolute url
+      def edit_record_url(*args)
+        options = args.extract_options!
+        record  = args.first
+
+        ActionCrud::Helpers::Route.new(self, record, :edit, options).url
+      end
+    end
+  end
+end

data/lib/action_crud/helpers/view.rb

@@ -0,0 +1,44 @@
+module ActionCrud
+  module Helpers
+    module View
+      # Get current model
+      def current_model
+        controller.try(:current_model)
+      end
+
+      # Get current record
+      def current_record
+        controller.try(:current_record) || current_model.try(:new)
+      end
+
+      # Get current records
+      def current_records
+        controller.try(:current_records) || []
+      end
+
+      # Get permitted parameters
+      def permitted_params
+        controller.try(:permitted_params) || []
+      end
+
+      # Get record link
+      def record_link_to(record=nil, *args)
+        options = args.extract_options!
+        action  = args.first
+
+        ActionCrud::Helpers::Link.new(self, record, action, options).render
+      end
+
+      # Get record links
+      def record_links_to(record=nil, *args)
+        options = args.extract_options!
+        default = options.fetch :html, {}
+        options = options.except(:html)
+        actions = args.concat(options.keys)
+        actions = actions.any? ? actions : [:show, :edit, :destroy]
+
+        ActionCrud::Helpers::Link.new(self, record, actions, default).render_multiple(options)
+      end
+    end
+  end
+end

data/lib/action_crud/pagination.rb

@@ -0,0 +1,57 @@
+module ActionCrud
+  module Pagination
+    extend ActiveSupport::Concern
+
+    included do
+      # Class attributes
+      class_attribute :per_page, instance_predicate: false
+
+      # Class attributes defaults
+      self.per_page = 20
+
+      # Action callbacks
+      before_action :set_pagination_params, only: [:index]
+    end
+
+    class_methods do
+      # Set per page limit
+      def set_per_page(limit)
+        self.per_page = limit.to_i
+      end
+    end
+
+    private
+
+      # Get pagination params
+      def pagination_params
+        @pagination_params ||= params.permit(:page, :per_page).to_h.deep_symbolize_keys
+      end
+
+      # Set pagination parameters
+      def set_pagination_params
+        pagination                   = pagination_params[:page].is_a?(Hash) ? pagination_params[:page] : {}
+        pagination_params[:page]     = pagination[:number] || pagination_params.fetch(:page, 1)
+        pagination_params[:per_page] = pagination[:size]   || pagination_params.fetch(:per_page, per_page)
+      end
+
+      # Paginate records
+      def paginate(records)
+        if records.respond_to? :paginate
+          records.paginate(pagination_params.select { |k, _v| k.in? [:page, :per_page] })
+        else
+          records
+        end
+      end
+
+      # Pagination metadata
+      def pagination_meta(records)
+        {
+          current_page:  pagination_params.fetch(:page, 1).to_i,
+          next_page:     records.try(:next_page),
+          previous_page: records.try(:previous_page),
+          total_pages:   records.try(:total_pages),
+          total_entries: records.try(:total_entries)
+        }
+      end
+  end
+end

data/lib/action_crud/version.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: action_crud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Description.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/action_crud.rb
+- lib/action_crud/controller.rb
+- lib/action_crud/helpers/link.rb
+- lib/action_crud/helpers/route.rb
+- lib/action_crud/helpers/url.rb
+- lib/action_crud/helpers/view.rb
+- lib/action_crud/pagination.rb
+- lib/action_crud/version.rb
+homepage: https://github.com/hardpixel/active-delegate
+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.13
+signing_key: 
+specification_version: 4
+summary: Summary
+test_files: []