resource_finder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47e024ca2888a84a19f0cc611b14ccb520b90aa17e3a7b1e38d0ee1781be1a9e
+  data.tar.gz: 723f623815bf2fb25ffa8eca31ddf77bd5b1721b313467f90a61d15baf35b571
+SHA512:
+  metadata.gz: e0638e4ffa8476374aa868e0f84b6c36cbfee546b2b489e08d27edf60e29e48aedce9f798825239ebb81acc8a89964fd84e9890b95815eb6741c85df1553afe4
+  data.tar.gz: 3548bd9d1bb1f69c197c90260ea9d0be0a8ae2562a0a4add0ea885aef137ea0d755671a9e3ae8354a101305da5e0115329a1390c51fe67f4879b2102b95ac78c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.rubocop.yml
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    resource_finder (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  resource_finder!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Charles Koyeung
+
+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,202 @@
+## ResourceFinder
+
+ResourceFinder is a simple Rails gem that finds resource for controller from request parameters. It lets you write less codes and eradicates repeat resource finding codes completely in every controller.
+
+### Purpose
+
+Generally, when we need to find the resource in controller for actions, we can do like this:
+
+```ruby
+class UsersController < ApplicationController
+
+  def show
+    @user = User.find(params[:id])
+  end
+
+  def edit
+    @user = User.find(params[:id])
+  end
+
+  def update
+    @user = User.find(params[:id])
+  end
+
+  def destroy
+    @user = User.find(params[:id])
+  end
+
+end
+```
+
+Or, we always use `before_action` makes it looks better:
+
+```ruby
+class UsersController < ApplicationController
+  before_action :find_user, only: [:show, :edit, :update, :destroy]
+
+  def show
+  end
+
+  def edit
+  end
+
+  def update
+  end
+
+  def destroy
+  end
+
+  private
+
+  def find_user
+    @user = User.find(params[:id])
+  end
+end
+```
+
+What we done above can solve the repeate codes problem in a single controller, but there will be a lots of controllers in Rails project, we need to define a lots of `find_xxx` methods in its controller. So ResourceFinder is designed to solve this problem.
+
+### Installation
+
+Add the gem to your Gemfile:
+
+    gem 'resource_finder'
+
+Install the gem with bundler:
+
+    bundle install
+
+### Usage
+
+To add ResourceFinder in your Rails project, first put it included in your ApplicationController.
+
+```ruby
+class ApplicationController
+  include ResourceFinder
+end
+```
+
+And then you can use it in every controllers which inherited from ApplicationController.
+
+```ruby
+class UsersController < ApplicationController
+  findable :user
+end
+```
+
+When nested resources, posts belongs to user.
+
+```ruby
+class PostsController < ApplicationController
+  findable :user
+  findable :post, scope: :user
+end
+```
+
+### Configuration
+
+Basicly, you can set `only` or `except` options like `before_action`, basides there are some useful keys for options:
+
+  - model
+  - query
+  - in
+  - of
+  - scope
+  - lazy
+  - silent
+
+#### Overriding the default model
+
+By default, ResourceFinder will detect model based on the object your set by `findable`.
+
+```ruby
+findable :customer # default Customer model
+findable :customer, model: User
+```
+
+#### Specific the key in parameters as query content in DB
+
+By default, ResourceFinder gets the query content by query name `object_id` in parameters.
+
+```ruby
+class PostsController < ApplicationController
+  findable :user # params[:user_id]
+end
+```
+
+But if the object model is same as the model deduced from current controller name. ResourceFinder will use `id` to get query content from parameters.
+
+```ruby
+class UsersController < ApplicationController
+  findable :user # params[:id]
+  findable :customer, model: User # params[:id]
+end
+```
+
+You can also pass a lambda/array/string/symbol to `query` options.
+
+```ruby
+findable :user, query: :uuid # params[:uuid]
+findable :user, query: [:user, :id] # params[:user][:id]
+findable :user, query: -> (params) { your_decoder params[:encode_user_id] }
+```
+
+#### Set query columns for ActiveReord
+
+By default, ResourceFinder uses `id` to query.
+
+```ruby
+findable :user # query in column: [:id]
+findable :user, in: :uuid # query in column: [:uuid]
+findable :user, in: [:id, :uuid] # query in columns: [:id, :uuid]
+```
+
+#### Scope limitation
+
+For nested resources, maybe you want to limit the resource.
+
+```ruby
+findable :user
+findable :post, scope: :user # make sure @post is one of @user.posts
+```
+
+#### Find resource on an existed resource
+
+```ruby
+findable :user
+findable :city, of: :user # same as: @city = user.city
+```
+
+#### Use it without setting instance variable
+
+Sometimes, you prefer to improve performance, `lazy: true` can let ResourceFinder be lazy load, also, there will be no any instance variables generated any more.
+
+```ruby
+class UsersController < ApplicationController
+  findable :user, lazy: true
+
+  def show
+    user = findable(:user)
+    render json: user
+  end
+end
+```
+
+#### Exception silent
+
+By default, ResourceFinder will be allowed to raise error during source finding. For example: RecordNotFound. You can set `silent: true` to prevent error raised.
+
+```ruby
+class UsersController < ApplicationController
+  findable :user, silent: true
+
+  def show
+    # if user record not found
+    # @user will be eq: nil
+  end
+end
+```
+
+### License
+
+Released under the [MIT](http://opensource.org/licenses/MIT) license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resource_finder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/resource_finder.rb

@@ -0,0 +1,36 @@
+require "resource_finder/version"
+require "resource_finder/finder"
+require "active_support/concern"
+
+# Use Finder
+module ResourceFinder
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :defined_finders, instance_writer: false, default: {}
+  end
+
+  private
+
+  def findable(name)
+    finder = defined_finders[name]
+    finder.call(self, true) if finder
+  end
+
+  def _find_resouces
+    defined_finders.each do |name, finder|
+      record = finder.call(self)
+      instance_variable_set("@#{name}", record) if record
+    end
+  end
+
+  # :nodoc:
+  module ClassMethods
+    def findable(name, options = {})
+      _defined_finders = self.defined_finders
+      self.defined_finders = _defined_finders.merge(name => Finder.new(name, options))
+
+      before_action :_find_resouces unless _defined_finders.present?
+    end
+  end
+end

data/lib/resource_finder/finder.rb

@@ -0,0 +1,94 @@
+module ResourceFinder
+  class Finder
+    attr :name, :options
+
+    def initialize(name, options)
+      @name = name.to_s
+      @options = options
+    end
+
+    def call(controller, force = false)
+      with_controller(controller) do
+        check_action(force) do
+          find_record
+        end
+      end
+    end
+
+    def with_controller(controller)
+      begin
+        @controller = controller
+        @params = controller.params
+
+        yield
+      ensure
+        remove_instance_variable '@controller'
+        remove_instance_variable '@params'
+      end
+    end
+
+    def check_action(skip_check)
+      return if options[:lazy] && !skip_check
+
+      action = @params[:action].to_sym
+      only_actions = Array.wrap options[:only]
+      except_actions = Array.wrap options[:except]
+
+      if (only_actions.empty? && except_actions.empty?) ||
+         (only_actions.present? && only_actions.include?(action)) ||
+         (except_actions.present? && except_actions.exclude?(action))
+         yield
+      end
+    end
+
+    def model
+      options[:model] || name.classify.constantize
+    end
+
+    def query
+      query_path = options[:query]
+
+      if query_path.nil?
+        ctrl_classify_name = @params[:controller].classify.demodulize
+        return model.name == ctrl_classify_name ? @params[:id] : @params["#{name}_id"]
+      end
+
+      case query_path
+      when Proc
+        query_path.call(@params)
+      when Array
+        @params.dig(*query_path)
+      when String, Symbol
+        @params[query_path]
+      end
+    end
+
+    def refer(finder_name)
+      @controller.instance_variable_get("@#{finder_name}") || @controller.send(:findable, finder_name)
+    end
+
+    def find_record
+      if options[:of]
+        parent = refer options[:of]
+        return parent.try(name)
+      end
+
+      columns = Array.wrap options[:in] || :id
+      sql = columns.map { |column| "#{column} = :value" }.join(' OR ')
+
+      relation = if options[:scope]
+        scope = refer options[:scope]
+        reflection = scope._reflections.detect do |key, _reflection|
+          _reflection.class_name == model.name || key == name.pluralize
+        end
+        scope.try(reflection.first)
+      else
+        model
+      end
+
+      relation.find_by!([sql, value: query])
+    rescue => e
+      raise e unless options[:silent]
+    end
+  end
+end

data/lib/resource_finder/version.rb

@@ -0,0 +1,3 @@
+module ResourceFinder
+  VERSION = "0.1.0"
+end

data/resource_finder.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "resource_finder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "resource_finder"
+  spec.version       = ResourceFinder::VERSION
+  spec.authors       = ["Charles Koyeung"]
+  spec.email         = ["cenxky@gmail.com"]
+
+  spec.summary       = "Find resource from parameters for controller in an easy way."
+  spec.description   = "Find resource from parameters for controller in an easy way."
+  spec.homepage      = "https://github.com/cenxky/resource_finder"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: resource_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Koyeung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Find resource from parameters for controller in an easy way.
+email:
+- cenxky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resource_finder.rb
+- lib/resource_finder/finder.rb
+- lib/resource_finder/version.rb
+- resource_finder.gemspec
+homepage: https://github.com/cenxky/resource_finder
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Find resource from parameters for controller in an easy way.
+test_files: []