simple_crudify 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 776659af4725f3b9d1303a58bf6c09c04c8d8172
-  data.tar.gz: a5c2dcd0ce90a9525d9c2444ab85bac420dd02a4
+SHA256:
+  metadata.gz: 53fde98453d5797fa5e81ff16ff835894ccf298d72ccdb659fafbb56c9140778
+  data.tar.gz: 8a01ab590746cfa9f2faacb36bf6848cc1fc4417b80a204a324e27910985e43b
 SHA512:
-  metadata.gz: db2015525cc38866d5dd653fe93e0a469dcac050eec64c7df4914c1576139ff29b2c3b92a4f10430f6af8495b1a6d7eb25233b56701d799fc937471dab94a4d1
-  data.tar.gz: dd6c78b0e31247b8d59157c9b47836e3cd054ebd1df7b5ee57d8188f62d7d6cb0b2cfbc1cf4e9abbf0ea16576248dff0946d2ca318e3c9620c1ae28c93ae90bb
+  metadata.gz: 329c6d64e83593858b427fdd48e84f14c634f0270e4dbfd2303a8e1b44d5306a48e1fdd1ec655587973a652a5a3607fb9abf7f3873d7b2ded46e0ba0626e9280
+  data.tar.gz: 3580f1032fb084eb81b0dab72a663ebc7b9cd749677c228588fc4159ec8109646c20ce658935a10d509b236c99e3396c48ad154aed8a22c060ee0e1b8c731150

data/.rubocop.yml

@@ -1,23 +1,7 @@
-
-AllCops:
-  Exclude:
-    - 'bin/*'
-    - 'spec/support'
-    - 'spec/factories'
-    - 'spec/fixtures'
-    - 'spec/support/*'
-    - 'spec/spec_helper.rb'
-    - 'spec/rails_helper.rb'
-  TargetRubyVersion: 2.4.1
-  DisplayCopNames: true
-
 Style/Encoding:
   Enabled: false
 
-Style/Documentation:
-  Enabled: false
-
-Style/SpaceAroundEqualsInParameterDefault:
+Layout/SpaceAroundEqualsInParameterDefault:
   EnforcedStyle: no_space
 
 Style/ParallelAssignment:
@@ -26,49 +10,5 @@ Style/ParallelAssignment:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Metrics/ModuleLength:
-  Exclude:
-    - "**/*_spec.rb"
-
-Metrics/BlockLength:
-  Exclude:
-    - "**/*_spec.rb"
-
 Metrics/LineLength:
-  Max: 160
-
-Metrics/MethodLength:
-  Max: 30
-
-Metrics/AbcSize:
-  Max: 80
-
-Metrics/BlockLength:
-  Max: 100
-
-Metrics/PerceivedComplexity:
-  Max: 20
-
-Metrics/CyclomaticComplexity:
-  Max: 20
-
-Metrics/ParameterLists:
-  Max: 10
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Layout/IndentationWidth:
-  Enabled: false
-
-Layout/IndentationConsistency:
-  Enabled: false
-
-Style/AccessModifierDeclarations:
-  Enabled: false
-
-Layout/AlignHash:
-  Enabled: false
-
-Layout/IndentHash:
-  Enabled: false
+  Max: 130

data/.travis.yml

@@ -1,5 +1,3 @@
-rvm:
-  - 2.4.1
 language: ruby
 
 script: bundle exec rspec

data/Gemfile.lock

@@ -1,19 +1,12 @@
 PATH
   remote: .
   specs:
-    simple_crudify (1.2.0)
+    simple_crudify (1.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
     diff-lcs (1.3)
-    docile (1.3.1)
-    json (2.1.0)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -28,22 +21,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
-  pry
   rake (~> 10.0)
   rspec (~> 3.0)
   simple_crudify!
-  simplecov
 
 BUNDLED WITH
-   1.16.1
+   1.16.6

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/getsimpleadmin/simple_crudify.svg?branch=master)](http://travis-ci.org/getsimpleadmin/simple_crudify)[![codecov.io](https://codecov.io/github/getsimpleadmin/simple_crudify/coverage.svg?branch=master)](https://codecov.io/github/getsimpleadmin/simple_crudify?branch=master)[![Gem Version](https://badge.fury.io/rb/simple_crudify.svg)](https://rubygems.org/gems/simple_crudify)
+[![Build Status](https://secure.travis-ci.org/getsimpleadmin/simple_crudify.svg?branch=master)](http://travis-ci.org/getsimpleadmin/simple_crudify)[![Gem Version](https://badge.fury.io/rb/simple_crudify.svg)](https://rubygems.org/gems/simple_crudify)
 # SimpleCrudify
 
 The simple_crudify gem is a lightweight library for writing simple CRUD controllers.
@@ -33,23 +33,27 @@ class UsersController < ApplicationController
     User
   end
 
+  def controller_notice(action_name)
+    t("resource.#{action_name}.success", resource_name: model_klass)
+  end
+
   private
 
-    def after_create_path
-      edit_user_path(@resource)
-    end
+  def after_create_path
+    edit_user_path(@resource)
+  end
 
-    def after_update_path
-      users_path
-    end
+  def after_update_path
+    users_path
+  end
 
-    def after_destroy_path
-      users_path
-    end
+  def after_destroy_path
+    users_path
+  end
 
-    def resource_params
-      params.require(:user).permit(:password, :phone, :email)
-    end
+  def resource_params
+    params.require(:user).permit(:password, :phone, :email)
+  end
 end
 ```
 
@@ -72,6 +76,14 @@ end
 
 Allow specifying the model class.
 
+```ruby
+  def controller_notice(action_name)
+    t("resource.#{action_name}.success", resource_name: model_klass)
+  end
+```
+
+Helps to simplify controller redirect notice
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/getsimpleadmin/simple_crudify. This project is intended to be a safe, welcoming space for collaboration.

data/lib/simple_crudify/common_methods.rb

@@ -1,17 +1,57 @@
 module SimpleCrudify
+  # Common methods that should implement in each controller
+  #
+  # @since 1.0.0
+  #
+  # @example
+  #
+  # class UsersController < ApplicationController
+  #   include SimpleCrudify::Crudify
+  #
+  #   actions :crud
+  #
+  #   def model_klass
+  #     User
+  #   end
+  #
+  #   # Notice for a user after redirect action
+  #
+  #   def controller_notice(action_name)
+  #     t("resource.#{action_name}.success", resource_name: model_klass)
+  #   end
+  #
+  #   private
+  #
+  #     def after_create_path
+  #       edit_user_path(@resource)
+  #     end
+  #
+  #     def after_update_path
+  #       users_path
+  #     end
+  #
+  #     def after_destroy_path
+  #       users_path
+  #     end
+  #
+  #     def resource_params
+  #       params.require(:user).permit(:password, :phone, :email)
+  #     end
+  # end
+  #
   module CommonMethods
     private
 
-      def controller_notice(_action_name)
-        raise NotImplementedError
-      end
+    def controller_notice(*_args)
+      raise NotImplementedError, 'You should use a unified interface, add #controller_notice method'
+    end
 
-      def resource_params
-        raise NotImplementedError
-      end
+    def resource_params
+      raise NotImplementedError, 'You should use a unified interface, add #resource_params method'
+    end
 
-      def template_path(controller_action=nil)
-        "#{params[:controller]}/#{controller_action || params[:action]}"
-      end
+    def template_path(controller_action=nil)
+      "#{params[:controller]}/#{controller_action || params[:action]}"
+    end
   end
 end

data/lib/simple_crudify/crud_actions.rb

@@ -1,5 +1,7 @@
 module SimpleCrudify
   module CrudActions
+    # @since 1.0.0
+    # @api private
     module Index
       def index
         @resources = model_klass.all
@@ -8,14 +10,18 @@ module SimpleCrudify
       end
     end
 
+    # @since 1.0.0
+    # @api private
     module Show
       def show
-        @resource = model_klass.find(params[:id])
+        @resource = ResourceHelper.resource(model_klass, params[:id])
 
         render template_path
       end
     end
 
+    # @since 1.0.0
+    # @api private
     module New
       def new
         @resource = model_klass.new
@@ -24,6 +30,8 @@ module SimpleCrudify
       end
     end
 
+    # @since 1.0.0
+    # @api private
     module Create
       def create
         @resource = model_klass.new(resource_params)
@@ -36,17 +44,21 @@ module SimpleCrudify
       end
     end
 
+    # @since 1.0.0
+    # @api private
     module Edit
       def edit
-        @resource = model_klass.find(params[:id])
+        @resource = ResourceHelper.resource(model_klass, params[:id])
 
         render template_path
       end
     end
 
+    # @since 1.0.0
+    # @api private
     module Update
       def update
-        @resource = model_klass.find(params[:id])
+        @resource = ResourceHelper.resource(model_klass, params[:id])
 
         if @resource.update(resource_params)
           redirect_to after_update_path, notice: controller_notice(action_name)
@@ -56,9 +68,11 @@ module SimpleCrudify
       end
     end
 
+    # @since 1.0.0
+    # @api private
     module Destroy
       def destroy
-        @resource = model_klass.find(params[:id])
+        @resource = ResourceHelper.resource(model_klass, params[:id])
         @resource.destroy
 
         redirect_to after_destroy_path, notice: controller_notice(action_name)

data/lib/simple_crudify/crudify.rb

@@ -1,14 +1,17 @@
 module SimpleCrudify
+  # Controller actions mapper, each action placed in different modules
+  #
+  # @since 1.0.0
   module Crudify
     include CommonMethods
 
     DEPENDENCIES_MAP = {
-      index:   CrudActions::Index,
-      show:    CrudActions::Show,
-      new:     CrudActions::New,
-      create:  CrudActions::Create,
-      edit:    CrudActions::Edit,
-      update:  CrudActions::Update,
+      index: CrudActions::Index,
+      show: CrudActions::Show,
+      new: CrudActions::New,
+      create: CrudActions::Create,
+      edit: CrudActions::Edit,
+      update: CrudActions::Update,
       destroy: CrudActions::Destroy
     }.freeze
 
@@ -16,18 +19,20 @@ module SimpleCrudify
       base.extend(ClassMethods)
     end
 
+    # @since 1.0.0
+    # @api private
     module ClassMethods
       private
 
-        def actions(*action_names)
-          if action_names.include?(:crud)
-            DEPENDENCIES_MAP.values.each { |action| include(action) }
-          else
-            action_names.each do |action|
-              include(DEPENDENCIES_MAP[action])
-            end
+      def actions(*action_names)
+        if action_names.include?(:crud)
+          DEPENDENCIES_MAP.values.each { |action| include(action) }
+        else
+          action_names.each do |action|
+            include(DEPENDENCIES_MAP[action])
           end
         end
+      end
     end
   end
 end

data/lib/simple_crudify/crudify_dynamic_resource.rb

@@ -1,4 +1,6 @@
 module SimpleCrudify
+  # @since 1.0.0
+  # @api private
   module CrudifyDynamicResource
     def create
       @resource = model_klass.new(resource_params)
@@ -10,7 +12,7 @@ module SimpleCrudify
     end
 
     def update
-      @resource = model_klass.find(params[:id])
+      @resource = ResourceHelper.resource(model_klass, params[:id])
       @resource.update(resource_params)
 
       respond_to do |format|
@@ -19,7 +21,7 @@ module SimpleCrudify
     end
 
     def destroy
-      @resource = model_klass.find(params[:id])
+      @resource = ResourceHelper.resource(model_klass, params[:id])
       @resource.destroy
 
       respond_to do |format|

data/lib/simple_crudify/resource_helper.rb

@@ -0,0 +1,17 @@
+module SimpleCrudify
+  # Module to easily handle additional gems that work with a model, like friendly_id
+  #
+  # @since 1.2.2
+  #
+  module ResourceHelper
+    module_function
+
+    def resource(model_klass, resource_id)
+      if defined?(FriendlyId)
+        model_klass.friendly.find_by_friendly_id(resource_id)
+      else
+        model_klass.find(resource_id)
+      end
+    end
+  end
+end

data/lib/simple_crudify/version.rb

@@ -1,3 +1,3 @@
 module SimpleCrudify
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.2.2'.freeze
 end

data/lib/simple_crudify.rb

@@ -1,10 +1,14 @@
 require 'simple_crudify/version'
 
+require 'simple_crudify/resource_helper'
 require 'simple_crudify/common_methods'
+
 require 'simple_crudify/crud_actions'
 require 'simple_crudify/crudify'
-
 require 'simple_crudify/crudify_dynamic_resource'
 
+# Lightweight library for writing simple CRUD controllers.
+#
+# @since 1.0.0
 module SimpleCrudify
 end

data/simple_crudify.gemspec

@@ -25,7 +25,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake',    '~> 10.0'
   spec.add_development_dependency 'rspec',   '~> 3.0'
-
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_crudify
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Dmitriy Strukov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,34 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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: simplecov
-  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: simple_crudify
 email:
 - dmitiry_strukov2011@mail.ru
@@ -103,6 +75,7 @@ files:
 - lib/simple_crudify/crud_actions.rb
 - lib/simple_crudify/crudify.rb
 - lib/simple_crudify/crudify_dynamic_resource.rb
+- lib/simple_crudify/resource_helper.rb
 - lib/simple_crudify/version.rb
 - simple_crudify.gemspec
 homepage: https://github.com/getsimpleadmin/simple_crudify
@@ -124,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: simple_crudify