friendly_routes 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20f66faa1c0ee03ba5ee4d409c3533c233fce5a6
-  data.tar.gz: 86d56ad4c80db6eaefc1b72ebaabc543ac61f74e
+  metadata.gz: e2d3509ebae256e805600bb631718d9489eeaf73
+  data.tar.gz: dd5d986628e21c2d693f579e1ab621bb3a259161
 SHA512:
-  metadata.gz: 587782afc11016d44dd17f9ed2b54e19e1f0c84ec99053ef6314473f1464460a5cfdba97f2c5839581f9815e4a0e26fcbe044e4e3e9ce010988289fba9497918
-  data.tar.gz: 45e249b6bd390058e8d3be82fe1b716c428ed064709554af10055b99a18819ee930841ee3d2d349e95d09a6c11f6b65635019b4d615f15e450bf93b03b554eb4
+  metadata.gz: e9aed8430ef5abc1f2e6fffcd3956022c0ab30904d7690a9c027c6c2c5f4edec643c97ed58a8ec60da8fc098b67406ab0d0c71295e8590f93808d80e44c1de2f
+  data.tar.gz: 14e92badb00980a1bb3efb5a134e713146920dc8c3c6aa71baa7c28623c65f9fa05c1c54f4d2cf12e5ed1d98babeb4dc364408d2c9149ac19116e106895a9d32

data/README.md

@@ -1,6 +1,7 @@
 # Friendly Routes
 Friendly Routes creates DSL for creating rails routes with human friendly URLs
 
+[![Gem Version](https://badge.fury.io/rb/friendly_routes.svg)](https://badge.fury.io/rb/friendly_routes)
 [![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
@@ -22,7 +23,8 @@ Or install it yourself as:
 ```bash
 $ gem install friendly_routes
 ```
-## Usage example
+## Examples
+### Routes.rb example
 
 ```ruby
 # config/routes.rb
@@ -37,57 +39,31 @@ second_dummies_route = FriendlyRoutes::Route.new([free, 'categories', category],
 
 friendly_url_for dummies_route, :get, '/' # '/:free/categories/:category'
 friendly_url_for dummies_route, :get, '/hello/' # '/hello/:free/categories/:category'
+```
+
+### Controller example
 
+```ruby
 # 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('/', 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
-FriendlyRoutes::Params::BooleanParams.new(:discount, true: :true_condition, false: :false_condition)
-```
+### Request result example
 
-collection param, pass **name**, **collection**, and **attribute** keys.
-```ruby
-FriendlyRoutes::Params::CollectionParams.new(:categories, Category.where(active: true), :title)
 ```
+ Categories:
+ <Category id: 1, title: "lorem">
+ <Category id: 2, title: "ipsum">
 
-hash param, pass **name**, **collection**, and **attribute** keys.
-```ruby
-FriendlyRoutes::Params::HashParams.new(:rooms, 'one-roomed' => 1, 'two-roomed' => 2)
-```
-4. Initialize route wih `friendly_url_for`
-```ruby
-friendly_url_for dummies_route, :get
-```
 
-### Controllers
-Simply call `parse_friendly_routes` before controller action to parse params.
-```ruby
-before_action :parse_friendly_routes, only: [:index]
+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}
 ```
 
 ## Contributing

data/lib/friendly_routes.rb

@@ -7,7 +7,9 @@ require 'friendly_routes/params/base'
 require 'friendly_routes/params/boolean_params'
 require 'friendly_routes/params/collection_params'
 require 'friendly_routes/params/hash_params'
+require 'friendly_routes/services/composer'
 require 'friendly_routes/services/constraints'
+require 'friendly_routes/services/multi_composer'
 require 'friendly_routes/services/parser'
 require 'friendly_routes/services/prefixed_param'
 require 'friendly_routes/services/prefixed_params'

data/lib/friendly_routes/params/base.rb

@@ -2,6 +2,11 @@
 
 module FriendlyRoutes
   module Params
+    # Abstract base class for route params.
+    #
+    # @abstract
+    # @attr [Symbol] type
+    # @attr [Symbol, String] name
     class Base
       attr_accessor :type, :name
 
@@ -11,13 +16,39 @@ module FriendlyRoutes
         @optional = optional
       end
 
+      # returns true if param is optional
       def optional?
         @optional == true
       end
 
+      # returns true if param required
+      def required?
+        @optional == false
+      end
+
+      # Regexp with allowed params
       def constraints
         raise NotImplementedError
       end
+
+      # Parse values from request
+      #
+      # Inverse of {compose}
+      def parse
+        raise NotImplementedError
+      end
+
+      # Generate request value from params
+      #
+      # Inverse of {parse}
+      def compose
+        raise NotImplementedError
+      end
+
+      # Check if value can be composed
+      def allowed?
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/friendly_routes/params/boolean_params.rb

@@ -2,6 +2,8 @@
 
 module FriendlyRoutes
   module Params
+    # @attr [String] true value for matching true
+    # @attr [String] false value for matching false
     class BooleanParams < Base
       attr_accessor :true, :false
 
@@ -16,10 +18,27 @@ module FriendlyRoutes
         Regexp.new "#{@true}|#{@false}"
       end
 
+      # (see Base#parse)
+      # @param [String] value request value
+      # @return [Boolean]
       def parse(value)
         value == @true
       end
 
+      # (see Base#compose)
+      # @param [Boolean] value
+      # @return [String] request value
+      def compose(value)
+        value ? @true : @false
+      end
+
+      # (see Base#allowed?)
+      # @param [Boolean] value
+      # @return [Boolean]
+      def allowed?(value)
+        [true, false].include? value
+      end
+
       private
 
       def check_params(options)

data/lib/friendly_routes/params/collection_params.rb

@@ -2,6 +2,10 @@
 
 module FriendlyRoutes
   module Params
+    # Created to work with ActiveRecord collection
+    #
+    # @attr [Object] collection Instance of ActiveRecord collection
+    # @attr [Symbol, String] key_attr name of attribute for matching
     class CollectionParams < Base
       attr_accessor :collection, :key_attr
 
@@ -16,10 +20,27 @@ module FriendlyRoutes
         Regexp.new @collection.all.map(&@key_attr).compact.map(&:downcase).join('|')
       end
 
+      # (see Base#parse)
+      # @param [String] value value of item key attr
+      # @return [Integer, nil] item id or nil if item not found
       def parse(value)
         @collection.find_by(@key_attr => value).try(:id)
       end
 
+      # (see Base#compose)
+      # @param [Integer] id id of collection member
+      # @return [String] member key attr
+      def compose(id)
+        @collection.find(id)[@key_attr]
+      end
+
+      # (see Base#allowed?)
+      # @param [Integer] id id of collection member
+      # @return [Boolean]
+      def allowed?(id)
+        @collection.exists?(id)
+      end
+
       private
 
       def check_params

data/lib/friendly_routes/params/hash_params.rb

@@ -2,6 +2,7 @@
 
 module FriendlyRoutes
   module Params
+    # @attr [Hash] hash *keys* are values for matching and *values* is needed values
     class HashParams < Base
       attr_accessor :hash
 
@@ -15,10 +16,27 @@ module FriendlyRoutes
         Regexp.new @hash.keys.join('|')
       end
 
+      # (see Base#parse)
+      # @param [String, Symbol] value hash key
+      # @return [Object] hash value
       def parse(value)
         @hash[value]
       end
 
+      # (see Base#compose)
+      # @param [Object] value hash value
+      # @return [String, Symbol] hash key
+      def compose(value)
+        @hash.key(value)
+      end
+
+      # (see Base#allowed?)
+      # @param [Integer] value hash value
+      # @return [Boolean]
+      def allowed?(value)
+        @hash.values.include?(value)
+      end
+
       private
 
       def check_params

data/lib/friendly_routes/route.rb

@@ -21,6 +21,10 @@ module FriendlyRoutes
       @params.select { |param| param.is_a?(FriendlyRoutes::Params::Base) }
     end
 
+    def required_params
+      dynamic_params.select(&:required?)
+    end
+
     def inspect
       dynamic_params.map(&:name).join(', ')
     end

data/lib/friendly_routes/services/composer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  # Compoer will map passed params to friendly_route params
+  class Composer
+    def initialize(route, params = {})
+      @route = route
+      @params = params.dup
+    end
+
+    def call
+      return unless @route
+      @route.dynamic_params.each do |param|
+        compose(param)
+      end
+      @params
+    end
+
+    def can_be_composed?
+      return unless @route
+      @route.required_params.all? do |param|
+        param.allowed? @params[param.name]
+      end
+    end
+
+    private
+
+    def compose(param)
+      value = @params[param.name]
+      return unless param.allowed?(value)
+      prefixed_name = FriendlyRoutes::PrefixedParam.new(param.name, @route.prefix).call
+      @params[prefixed_name] = param.compose(value)
+      @params.delete(param.name) unless param.name == prefixed_name
+    end
+  end
+end

data/lib/friendly_routes/services/multi_composer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  # Compoer will map passed params to friendly_route params
+  class MultiComposer
+    attr_reader :matched_route
+
+    def initialize(routes, params = {})
+      @routes = routes
+      @params = params.dup
+    end
+
+    def call
+      compose unless @composed_params
+      @composed_params
+    end
+
+    private
+
+    def compose
+      @routes.each do |route|
+        composer = Composer.new(route, @params)
+        next unless composer.can_be_composed?
+        @matched_route = route
+        @composed_params = composer.call
+        break
+      end
+    end
+  end
+end

data/lib/friendly_routes/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_routes
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Roman Gritsay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -147,7 +147,9 @@ files:
 - lib/friendly_routes/params/collection_params.rb
 - lib/friendly_routes/params/hash_params.rb
 - lib/friendly_routes/route.rb
+- lib/friendly_routes/services/composer.rb
 - lib/friendly_routes/services/constraints.rb
+- lib/friendly_routes/services/multi_composer.rb
 - lib/friendly_routes/services/parser.rb
 - lib/friendly_routes/services/prefixed_param.rb
 - lib/friendly_routes/services/prefixed_params.rb