serial_fetcher 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9473c55de75f60712d7fc3414f8ddfc1432c1d5a
+  data.tar.gz: 46459962b81d3f6fa43476bf2de61b12d192e1a3
+SHA512:
+  metadata.gz: c4c6852aac20e727fc5aa4d639b3cd915b594049edc1b3c909c9941cfbf9dd97fd9796c164b2874d627b29601bf6348b225a05bbf40af54b009acb4424d3333a
+  data.tar.gz: 56f8483cdb10b09d7498a40d998120adfaef7089b74df437518aa91ef786e72e24a16106f8d9dac9f7a1cafd5004f3026cd89c170c55170f847ead5a9ca34a67

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+serial_fetcher

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Olivier Berho
+
+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,128 @@
+# SerialFetcher
+
+Serial Fetcher provides a way to automatically fetch a list of resources from
+the params hash.
+
+The params must be passed to the `fetch` method with a `schema` describing the
+associations between params and models.
+
+A fetcher must be provided to the SerialFetcher through configuration.
+By default there is an ActiveRecord fetcher that call `find` to the constantized
+class name.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serial_fetcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serial_fetcher
+
+## Usage
+
+Suppose you have an url like :
+
+    http://localhost:3000/users/1/blogs/5/posts/35/comments/3
+
+The corresponding params are :
+
+```ruby
+params: {
+  user_id: "1",
+  blog_id: "5",
+  post_id: "35",
+  id: "3"
+}
+```
+
+Now in your comments_controller.rb, you probably have something like :
+
+```ruby
+@user = User.find params[:user_id]
+@blog = Blog.find params[:blog_id]
+@post = Post.find params[:post_id]
+@comment = User.find params[:id]
+```
+
+With SerialFetcher, you could just write :
+
+```ruby
+@store = SerialFetcher.fetch(params, id: :comment)
+```
+
+And then @store will be created with :
+
+```ruby
+@store = {
+  user: User.find params[:user_id],
+  blog: Blog.find params[:blog_id],
+  post: Post.find params[:post_id],
+  comment: Comment.find params[:id]
+}
+```
+You must provide the resource associated to the :id param.
+The script will parse all the params containing '_id', and try to fetch the
+corresponding resources.
+
+Particular case if your param is not named like the model :
+
+```ruby
+schema: {
+  id: :comment,
+  post_id: :article,
+}
+
+@store = SerialFetcher.fetch(params, schema)
+```
+
+And then @store will be created with :
+
+```ruby
+@store = {
+  article: Article.find params[:post_id],
+  comment: Comment.find params[:id]
+}
+```
+You can provide your own fetcher in an initializer :
+
+```ruby
+SerialFetcher.configure |config|
+
+  # If we define repositories for our models, with a
+  # fetch_for_id method
+  config.fetcher = ->(param_name, param) {
+    begin
+      klass_name = "#{param_name}_repository".camelize
+      klass = klass_name.constantize
+      klass.send(:fetch_for_id, param)
+    rescue NameError
+      # The repository does not exist for the given param
+      nil
+    end
+  }
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/o-bo/serial_fetcher.
+
+
+## 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 => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "serial_fetcher"
+
+# 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

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/serial_fetcher.rb

@@ -0,0 +1,38 @@
+require "serial_fetcher/version"
+require "serial_fetcher/configuration"
+
+module SerialFetcher
+
+  class << self
+    attr_accessor :configuration
+  end
+
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+
+  def self.fetch(params, schema={})
+    config = self.configuration ||= Configuration.new
+    fetcher = config.fetcher
+
+    raise "You must provide a fetcher method." if fetcher.nil?
+    raise "You must provide a hash for params." if params.nil?
+    raise "You must provide the key id for the basic resource to be fetched." if schema[:id].nil?
+
+    params.keys.each_with_object({}) do |k, res|
+      key_id = schema[k]
+      if key_id
+        param_name = key_id.to_s
+        res[key_id] = fetcher.(param_name, params[k])
+      else
+        if /.*_id/.match(k.to_s)
+          param_name = k.to_s.split('_id').first
+          res[param_name.to_sym] = fetcher.(param_name, params[k])
+        end
+      end
+    end
+  end
+end

data/lib/serial_fetcher/configuration.rb

@@ -0,0 +1,13 @@
+require "serial_fetcher/fetchers/active_record_fetcher"
+
+module SerialFetcher
+  class Configuration
+
+    attr_accessor :fetcher
+
+
+    def initialize
+      @fetcher = SerialFetcher::Fetchers::ActiveRecordFetcher.get
+    end
+  end
+end

data/lib/serial_fetcher/fetchers/active_record_fetcher.rb

@@ -0,0 +1,18 @@
+module SerialFetcher
+  module Fetchers
+    class ActiveRecordFetcher
+
+      def self.get
+        ->(param_name, param) {
+          begin
+            klass_name = param_name.camelize
+            klass = klass_name.constantize
+            klass.send(:find, param)
+          rescue NameError
+            nil
+          end
+        }
+      end
+    end
+  end
+end

data/lib/serial_fetcher/version.rb

@@ -0,0 +1,3 @@
+module SerialFetcher
+  VERSION = "1.0.3"
+end

data/serial_fetcher.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serial_fetcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serial_fetcher"
+  spec.version       = SerialFetcher::VERSION
+  spec.authors       = ["o-bo"]
+
+  spec.summary       = %q{A script to ease fetching data from hash params in ruby applications.}
+  spec.description   = %q{Serial Fetcher provides a way to automatically fetch a list of resources from the params hash. The params must be passed to the `fetch` method with a `schema` describing the associations between params and models. A fetcher must be provided to the SerialFetcher through configuration. By default there is an ActiveRecord fetcher that call `find` to the constantized class name.}
+  spec.homepage      = "https://github.com/o-bo/serial_fetcher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: serial_fetcher
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- o-bo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: Serial Fetcher provides a way to automatically fetch a list of resources
+  from the params hash. The params must be passed to the `fetch` method with a `schema`
+  describing the associations between params and models. A fetcher must be provided
+  to the SerialFetcher through configuration. By default there is an ActiveRecord
+  fetcher that call `find` to the constantized class name.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/serial_fetcher.rb
+- lib/serial_fetcher/configuration.rb
+- lib/serial_fetcher/fetchers/active_record_fetcher.rb
+- lib/serial_fetcher/version.rb
+- serial_fetcher.gemspec
+homepage: https://github.com/o-bo/serial_fetcher
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A script to ease fetching data from hash params in ruby applications.
+test_files: []