base_resource 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e38d2791db6dc21af07087ddc3f78d8777187f4
+  data.tar.gz: 72ebe538eb6c29ee180acd4171fd0f61a7595588
+SHA512:
+  metadata.gz: 518a4406819af0ae6e634ef8b357a48c33a85748b6ed650689719cc4c5a599b1f45df76d302d61d677661899c511ca5a284e98c7bea7887eb120f56aca11cdb3
+  data.tar.gz: 7257c83bfa11b03609fa1a69940b4b4ed5b5887ba6265d11c59cc6acfb08a4feb04dd01df51b798e7781fcd887f1cad0280d3a10cd499018582be657be358adc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 mars
+
+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,40 @@
+# BaseResource
+Base Controller Resource Query
+
+## dependences
+```
+# gem 'jbuilder', '~> 2.5'
+# 表单
+gem 'reform'
+gem 'reform-rails'
+# 分页
+gem 'kaminari'
+# 搜索
+gem 'ransack'
+```
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'base_resource', github: 'rails-gems/base-resource'
+```
+And then execute:
+```bash
+$ bundle
+```
+and then
+```
+class ApplicationController < ActionController::Base
+  include BaseResource
+end
+```
+
+## 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    = 'BaseResource'
+  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/base_resource.rb

@@ -0,0 +1,8 @@
+require('base_resource/actions')
+module BaseResource
+  include Actions
+end
+
+# class ActionController::API
+#   include BaseResource
+# end

data/lib/base_resource/actions.rb

@@ -0,0 +1,110 @@
+require('base_resource/instance_methods')
+require('base_resource/pagination')
+require('base_resource/search')
+module BaseResource
+  module Actions
+    include InstanceMethods
+    include Pagination
+    include Search
+
+    def index resources = nil
+      resources = find_base_resources resources
+      if block_given?
+        resources = yield(resources)
+      end
+      instance_variable_set("@#{resources_name(resources)}", paginate(resources.order(id: :desc)))
+    end
+    alias_method :br_index, :index
+    # or in ruby > 2.2, child can call parent method use below method
+    # method(:index).super_method.call
+
+    def show
+      resource = find_base_resource
+      instance_variable_set("@#{resource_name(resource)}", resource)
+      if block_given?
+        yield(resource)
+      end
+    end
+    alias_method :br_show, :show
+
+    def create options = {}
+      options = {auto_render_success: true, auto_render_error: true, custom_save: false}.merge!(options || {})
+      form = form_const.new(resource_klass.new)
+      instance_variable_set("@#{resource_name(form.model)}", form.model)
+      if form.validate(params)
+        if options[:custom_save]
+          form.save do |hash|
+            yield hash, form
+          end if block_given?
+        else
+          if form.save
+            yield true if block_given?
+            render json: { msg: :successfully_create }, status: 200  and return if options[:auto_render_success]
+          else
+            yield false if block_given?
+            render json: { msg: form.errors.full_messages.first || form.model.errors.full_messages.first }, status: 422 and return if options[:auto_render_error]
+          end
+        end
+      else
+        yield false if block_given? && !options[:custom_save]
+        render json: { msg: form.errors.full_messages.first }, status: 422  and return if options[:auto_render_error]
+      end
+    end
+    alias_method :br_create, :create
+
+    def update resource = nil
+      form = form_const.new(resource || resource_klass.find(params[:id]))
+      if form.validate(params) && form.save
+        resource = form.model
+        instance_variable_set("@#{resource_name(resource)}", resource)
+        if block_given?
+          yield resource
+        else
+          render json: { msg: :successfully_update }, status: 200
+        end
+      else
+        render json: { msg: form.errors.full_messages.first || form.model.errors.full_messages.first }, status: 422
+      end
+    end
+    alias_method :br_update, :update
+
+    def destroy
+      resource = destroy_resource
+      instance_variable_set("@#{resource_name(resource)}", resource)
+      if block_given?
+        yield resource
+      else
+        render json: { msg: :successfully_destroy }, status: 200
+      end
+    end
+    alias_method :br_destroy, :destroy
+
+    protected
+
+    def find_base_resources resources = nil
+      search = (resources || resource_klass).ransack(prepare_search_condition)
+      search.sorts = prepare_search_sorts if search.sorts.empty? && prepare_search_sorts.present?
+      search.result(distinct: true)
+    end
+
+    def find_base_resource(id = nil)
+      id ||= respond_to?(:params) && params.is_a?(ActionController::Parameters) && params[:id]
+      resource_klass.find id
+    end
+
+    def destroy_resource(id = nil)
+      id ||= respond_to?(:params) && params.is_a?(ActionController::Parameters) && params[:id]
+      resource_klass.destroy id
+    end
+
+    def form_const
+      namespaces = self.class.to_s.split("::")
+      const = while namespaces.present?
+                const = "#{namespaces.join('::')}::#{resource_klass_name}Form::#{action_name.classify}".constantize rescue nil
+                break const if const
+                namespaces.pop
+              end
+      const || "#{resource_klass_name}Form::#{action_name.classify}".try(:constantize)
+    end
+  end
+end

data/lib/base_resource/instance_methods.rb

@@ -0,0 +1,23 @@
+module BaseResource
+  module InstanceMethods
+    # name of the singular resource eg: 'user'
+    def resource_name(resource = nil)
+      resource ? resource.class.to_s.singularize.underscore : controller_name.singularize.underscore
+    end
+
+    # name of the resource collection eg: 'users'
+    def resources_name(resources = nil)
+      resources ? resources.model.to_s.pluralize.underscore : controller_name.pluralize.underscore
+    end
+
+    # eg: return 'User' string
+    def resource_klass_name
+      resource_name.classify
+    end
+
+    #  eg: return User klass
+    def resource_klass
+      resource_klass_name.constantize
+    end
+  end
+end

data/lib/base_resource/pagination.rb

@@ -0,0 +1,15 @@
+module BaseResource
+  module Pagination
+
+    protected
+
+    def paginate resources = nil
+      resources = (resources || @resources).page(params[:page] || 1)
+      # default per_page is 25
+      if params[:per_page]
+        resources = resources.per(params[:per_page])
+      end
+      resources
+    end
+  end
+end

data/lib/base_resource/search.rb

@@ -0,0 +1,19 @@
+module BaseResource
+  module Search
+
+    protected
+
+    def prepare_search_condition
+      search_keys = params.keys.map { |key| key.sub('q_', '') if key.start_with? 'q_' }.compact
+      return if search_keys.empty?
+      search_keys.each_with_object({}) do |key, search_hash|
+        # if you can add special condition
+        search_hash[key] = params["q_#{key}"]
+      end
+    end
+
+    def prepare_search_sorts
+      params[:qs_sorts]
+    end
+  end
+end

data/lib/base_resource/version.rb

@@ -0,0 +1,3 @@
+module BaseResource
+  VERSION = '0.1.6'
+end

data/lib/tasks/base_resource_tasks.rake

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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: base_resource
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- mars
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: reform
+  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: reform-rails
+  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: kaminari
+  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: ransack
+  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: 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: Controller base Resource.
+email:
+- 578595193@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/base_resource.rb
+- lib/base_resource/actions.rb
+- lib/base_resource/instance_methods.rb
+- lib/base_resource/pagination.rb
+- lib/base_resource/search.rb
+- lib/base_resource/version.rb
+- lib/tasks/base_resource_tasks.rake
+homepage: https://github.com/wuyuedefeng/base-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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Controller base Resource.
+test_files: []