friendly_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70334657055066f9b06ff494e4da152f2b550ff7
+  data.tar.gz: bd6ce37d205ed5eff3f93f9664f20fefa81a4a86
+SHA512:
+  metadata.gz: 3686f6b415ef16fee8ac88055b9446e37eb218bbabbb61c2fc432a05449299415fc4856bcb0fd7e175c72bcce6ebc93c8e27655c5a4db2eb42247edaa19e4c68
+  data.tar.gz: 0b4fb915304f26dccdef5063ad73dbfef4970656bb2065372a477e0085ef47a9df53cd59dea55e8fb95609439b09df7788ab2d2d03eb22538eb031f3003b1077

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Roman Gritsay
+
+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,85 @@
+# Friendly Routes
+Friendly Routes creates DSL for creating rails routes with human friendly URLs
+
+[![Code Climate](https://codeclimate.com/github/RoM4iK/friendly_routes/badges/gpa.svg)](https://codeclimate.com/github/RoM4iK/friendly_routes)
+[![Build Status](https://travis-ci.org/RoM4iK/friendly_routes.svg?branch=master)](https://travis-ci.org/RoM4iK/friendly_routes)
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'friendly_routes'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install friendly_routes
+```
+## Usage example
+
+```ruby
+# config/routes.rb
+dummies_route = FriendlyRoutes::Route.new(:get, '/', controller: :dummies, action: :index)
+dummies_route.boolean(:free, true: :free, false: :paid)
+dummies_route.collection(:category_id, Category, :title)
+friendly_url_for dummies_route
+
+# app/controllers/dummies_controller.rb
+class DummiesController < ApplicationController
+  before_action :parse_friendly_routes, only: [:index]
+  def index
+  end
+end
+
+#  Categories:
+#  <Category id: 1, title: "lorem">
+#  <Category id: 2, title: "ipsum">
+
+
+# GET "/free/lorem" - { free: true, category_id: 1}
+# GET "/free/ipsum" - { free: true, category_id: 2}
+# GET "/paid/lorem" - { free: false, category_id: 1}
+# GET "/paid/ipsum" - { free: false, category_id: 2}
+```
+
+## Configuration
+### Routes
+
+1. Create new route, pass **method**, **path**, **controller name**, and **action** to it.
+```ruby
+dummies_route = FriendlyRoutes::Route.new(:get, '/', controller: :dummies, action: :index)
+```
+2. Create route params. *Note: params in route will be accepted in creation order*
+
+Boolean param, pass **name**, and hash with **true** and **false** keys.
+```ruby
+dummies_route.boolean(:discount, true: :true_condition, false: :false_condition)
+```
+
+collection param, pass **name**, **collection**, and **attribute** keys.
+```ruby
+dummies_route.collection(:categories, Category.where(active: true), :title)
+```
+3. Initialize route wih `friendly_url_for`
+```ruby
+friendly_url_for dummies_route
+```
+
+### Controllers
+Simply call `parse_friendly_routes` before controller action to parse params.
+```ruby
+before_action :parse_friendly_routes, only: [:index]
+```
+
+## Contributing
+Feel free to contribute into this repository by creating pull requests.
+
+## 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,19 @@
+# frozen_string_literal: true
+
+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    = 'FriendlyRoutes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/friendly_routes/dispatcher.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  module Dispatcher
+    def friendly_url_for(route)
+      public_send(
+        route.method,
+        route.path,
+        controller: route.controller,
+        action: route.action,
+        friendly_route: route,
+        constraints: route.constraints,
+        as: route.as
+      )
+    end
+  end
+end

data/lib/friendly_routes/helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  module Helper
+    def parse_friendly_routes
+      FriendlyRoutes::Parser.new(params).call
+    end
+  end
+end

data/lib/friendly_routes/params/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  module Params
+    class Base
+      attr_accessor :type, :name
+
+      def initialize(type, name)
+        @type = type
+        @name = name
+      end
+
+      def constraints
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/friendly_routes/params/boolean.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  module Params
+    class Boolean < Base
+      attr_accessor :true, :false
+
+      def initialize(name, options)
+        check_params(options)
+        super(:boolean, name)
+        @true = options[:true]
+        @false = options[:false]
+      end
+
+      def constraints
+        Regexp.new "#{@true}|#{@false}"
+      end
+
+      def parse(value)
+        value == @true
+      end
+
+      private
+
+      def check_params(options)
+        valid = options.is_a?(Hash) && options[:true] && options[:false]
+        raise ArgumentError, 'True and false options is required' unless valid
+      end
+    end
+  end
+end

data/lib/friendly_routes/params/collection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  module Params
+    class Collection < Base
+      attr_accessor :collection, :key_attr
+
+      def initialize(name, collection, key_attr)
+        super(:collection, name)
+        @collection = collection
+        @key_attr = key_attr
+        check_params
+      end
+
+      def constraints
+        Regexp.new @collection.all.map(&@key_attr).join('|')
+      end
+
+      def parse(value)
+        @collection.find_by(@key_attr => value).try(:id)
+      end
+
+      private
+
+      def check_params
+        unless @collection.try(:has_attribute?, @key_attr)
+          raise ArgumentError, "Collection not passed, or doesn't have passed attribute"
+        end
+      end
+    end
+  end
+end

data/lib/friendly_routes/parser.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  class Parser
+    def initialize(params)
+      @params = params
+      @route = @params[:friendly_route]
+    end
+
+    def call
+      @route.params.each do |param|
+        parse(param)
+      end
+    end
+
+    private
+
+    def parse(param)
+      value = @params[@route.prefixed_param_name(param)]
+      return unless value
+      @params[param.name] = param.parse(value)
+    end
+  end
+end

data/lib/friendly_routes/route.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  class Route
+    attr_accessor :method, :controller, :action, :params, :prefix
+
+    def initialize(method, path, controller: nil, action: nil, prefix: 'friendly_routes')
+      @method = method
+      @original_path = path
+      @controller = controller
+      @action = action
+      @params = []
+      @prefix = prefix
+    end
+
+    def boolean(name, params)
+      @params.push(Params::Boolean.new(name, params))
+    end
+
+    def collection(name, collection, key_attr)
+      @params.push(Params::Collection.new(name, collection, key_attr))
+    end
+
+    def path
+      @original_path + mapped_params
+    end
+
+    def prefixed_param_name(param)
+      "#{@prefix}_#{param.name}"
+    end
+
+    def as
+      "#{@prefix}_#{@controller}_#{@action}"
+    end
+
+    def constraints
+      @params.map do |param|
+        [prefixed_param_name(param).to_sym, param.constraints]
+      end.to_h
+    end
+
+    private
+
+    def mapped_params
+      mapped = @params.map do |param|
+        ':' + prefixed_param_name(param)
+      end
+      mapped.join('/')
+    end
+  end
+end

data/lib/friendly_routes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  VERSION = '0.1.0'
+end

data/lib/friendly_routes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'friendly_routes/dispatcher'
+require 'friendly_routes/helper'
+require 'friendly_routes/parser'
+require 'friendly_routes/route'
+require 'friendly_routes/params/base'
+require 'friendly_routes/params/boolean'
+require 'friendly_routes/params/collection'
+
+module FriendlyRoutes
+end
+
+ActionDispatch::Routing::Mapper.include FriendlyRoutes::Dispatcher
+ActiveSupport.on_load(:action_controller) do
+  include FriendlyRoutes::Helper
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: friendly_routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Gritsay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !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'
+- !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: rspec-rails
+  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: factory_girl_rails
+  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: database_cleaner
+  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: faker
+  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: Friendly routes creates DSL for creating rails routes with human friendly
+  URLs
+email:
+- w2@live.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/friendly_routes.rb
+- lib/friendly_routes/dispatcher.rb
+- lib/friendly_routes/helper.rb
+- lib/friendly_routes/params/base.rb
+- lib/friendly_routes/params/boolean.rb
+- lib/friendly_routes/params/collection.rb
+- lib/friendly_routes/parser.rb
+- lib/friendly_routes/route.rb
+- lib/friendly_routes/version.rb
+homepage: https://github.com/RoM4iK/friendly_routes
+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: Human friendly routes for Rails application
+test_files: []