friendly_routes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70334657055066f9b06ff494e4da152f2b550ff7
-  data.tar.gz: bd6ce37d205ed5eff3f93f9664f20fefa81a4a86
+  metadata.gz: 7de0ba5374e04ea6b36c94db8b69f578625d93e1
+  data.tar.gz: 637009a6c665bb90b54aa4256accab74d61aa9fa
 SHA512:
-  metadata.gz: 3686f6b415ef16fee8ac88055b9446e37eb218bbabbb61c2fc432a05449299415fc4856bcb0fd7e175c72bcce6ebc93c8e27655c5a4db2eb42247edaa19e4c68
-  data.tar.gz: 0b4fb915304f26dccdef5063ad73dbfef4970656bb2065372a477e0085ef47a9df53cd59dea55e8fb95609439b09df7788ab2d2d03eb22538eb031f3003b1077
+  metadata.gz: c5e2aa090122f1eecdef2e61ddeb63fb9dccb8a7c75b802a39e07f9ff137fbb5f991a8e66fa44092387aa39dbce6a737ac985eb71d77d61f48d99f3146411f84
+  data.tar.gz: 919abe796d939ef71af29b6b907f9e16ba79f4c77ec5d309ea42588df2084f4793b0217b2cff4abd34630bc021c53046fc1bf43f8351e2882d2766d37a89bf16

data/README.md

@@ -26,10 +26,18 @@ $ gem install friendly_routes
 
 ```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
+free = FriendlyRoutes::Params::BooleanParams.new(:free, true: :free, false: :paid)
+category = FriendlyRoutes::Params::CollectionParams.new(:category_id, Category, :title)
+
+dummies_route = FriendlyRoutes::Route.new('/', controller: :dummies, action: :index)
+dummies_route.params = [free, category]
+
+friendly_url_for dummies_route, :get # '/:free/:category'
+
+second_dummies_route = FriendlyRoutes::Route.new(:get, '/', controller: :dummies, action: :index)
+dummies_route.params = [free, 'categories', category]
+
+friendly_url_for dummies_route, :get # '/:free/categories/:category'
 
 # app/controllers/dummies_controller.rb
 class DummiesController < ApplicationController
@@ -54,22 +62,27 @@ end
 
 1. Create new route, pass **method**, **path**, **controller name**, and **action** to it.
 ```ruby
-dummies_route = FriendlyRoutes::Route.new(:get, '/', controller: :dummies, action: :index)
+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
-dummies_route.boolean(:discount, true: :true_condition, false: :false_condition)
+FriendlyRoutes::Params::BooleanParams.new(: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)
+FriendlyRoutes::Params::CollectionParams.new(:categories, Category.where(active: true), :title)
+```
+
+hash param, pass **name**, **collection**, and **attribute** keys.
+```ruby
+FriendlyRoutes::Params::HashParams.new(:rooms, 'one-roomed' => 1, 'two-roomed' => 2)
 ```
-3. Initialize route wih `friendly_url_for`
+4. Initialize route wih `friendly_url_for`
 ```ruby
-friendly_url_for dummies_route
+friendly_url_for dummies_route, :get
 ```
 
 ### Controllers

data/lib/friendly_routes/dispatcher.rb

@@ -2,15 +2,15 @@
 
 module FriendlyRoutes
   module Dispatcher
-    def friendly_url_for(route)
+    def friendly_url_for(route, method, as: '')
       public_send(
-        route.method,
+        method,
         route.path,
         controller: route.controller,
         action: route.action,
         friendly_route: route,
         constraints: route.constraints,
-        as: route.as
+        as: as
       )
     end
   end

data/lib/friendly_routes/params/base.rb

@@ -5,9 +5,14 @@ module FriendlyRoutes
     class Base
       attr_accessor :type, :name
 
-      def initialize(type, name)
+      def initialize(type, name, optional)
         @type = type
         @name = name
+        @optional = optional
+      end
+
+      def optional?
+        @optional == true
       end
 
       def constraints

data/lib/friendly_routes/params/{boolean.rb → boolean_params.rb}

@@ -2,12 +2,12 @@
 
 module FriendlyRoutes
   module Params
-    class Boolean < Base
+    class BooleanParams < Base
       attr_accessor :true, :false
 
-      def initialize(name, options)
+      def initialize(name, options, optional: true)
         check_params(options)
-        super(:boolean, name)
+        super(:boolean, name, optional)
         @true = options[:true]
         @false = options[:false]
       end

data/lib/friendly_routes/params/{collection.rb → collection_params.rb}

@@ -2,18 +2,18 @@
 
 module FriendlyRoutes
   module Params
-    class Collection < Base
+    class CollectionParams < Base
       attr_accessor :collection, :key_attr
 
-      def initialize(name, collection, key_attr)
-        super(:collection, name)
+      def initialize(name, collection, key_attr, optional: true)
+        super(:collection, name, optional)
         @collection = collection
         @key_attr = key_attr
         check_params
       end
 
       def constraints
-        Regexp.new @collection.all.map(&@key_attr).join('|')
+        Regexp.new @collection.all.map(&@key_attr).compact.map(&:downcase).join('|')
       end
 
       def parse(value)
@@ -23,8 +23,8 @@ module FriendlyRoutes
       private
 
       def check_params
-        unless @collection.try(:has_attribute?, @key_attr)
-          raise ArgumentError, "Collection not passed, or doesn't have passed attribute"
+        if @collection.nil? || @key_attr.nil?
+          raise ArgumentError, 'Collection or key attribute not passed'
         end
       end
     end

data/lib/friendly_routes/params/hash_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  module Params
+    class HashParams < Base
+      attr_accessor :hash
+
+      def initialize(name, hash, optional: true)
+        super(:collection, name, optional)
+        @hash = hash
+        check_params
+      end
+
+      def constraints
+        Regexp.new @hash.keys.join('|')
+      end
+
+      def parse(value)
+        @hash[value]
+      end
+
+      private
+
+      def check_params
+        raise ArgumentError, 'Invalid hash passed' unless @hash.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/friendly_routes/route.rb

@@ -4,8 +4,7 @@ module FriendlyRoutes
   class Route
     attr_accessor :method, :controller, :action, :params, :prefix
 
-    def initialize(method, path, controller: nil, action: nil, prefix: 'friendly_routes')
-      @method = method
+    def initialize(path, controller: nil, action: nil, prefix: 'friendly_routes')
       @original_path = path
       @controller = controller
       @action = action
@@ -13,39 +12,20 @@ module FriendlyRoutes
       @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}"
+      @original_path + FriendlyRoutes::PrefixedParams.new(@params, @prefix).call
     end
 
     def constraints
-      @params.map do |param|
-        [prefixed_param_name(param).to_sym, param.constraints]
-      end.to_h
+      FriendlyRoutes::Constraints.new(dynamic_params, @prefix).call
     end
 
-    private
+    def dynamic_params
+      @params.select { |param| param.is_a?(FriendlyRoutes::Params::Base) }
+    end
 
-    def mapped_params
-      mapped = @params.map do |param|
-        ':' + prefixed_param_name(param)
-      end
-      mapped.join('/')
+    def inspect
+      dynamic_params.map(&:name).join(', ')
     end
   end
 end

data/lib/friendly_routes/services/constraints.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  class Constraints
+    def initialize(params, prefix)
+      @params = params
+      @prefix = prefix
+    end
+
+    def call
+      @params.map do |param|
+        [FriendlyRoutes::PrefixedParam.new(param.name, @prefix).call.to_sym, param.constraints]
+      end.to_h
+    end
+  end
+end

data/lib/friendly_routes/{parser.rb → services/parser.rb}

@@ -8,7 +8,8 @@ module FriendlyRoutes
     end
 
     def call
-      @route.params.each do |param|
+      return unless @route
+      @route.dynamic_params.each do |param|
         parse(param)
       end
     end
@@ -16,9 +17,11 @@ module FriendlyRoutes
     private
 
     def parse(param)
-      value = @params[@route.prefixed_param_name(param)]
+      prefixed_name = FriendlyRoutes::PrefixedParam.new(param.name, @route.prefix).call
+      value = @params[prefixed_name]
       return unless value
       @params[param.name] = param.parse(value)
+      @params.delete(prefixed_name)
     end
   end
 end

data/lib/friendly_routes/services/prefixed_param.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  class PrefixedParam
+    def initialize(param, prefix)
+      @param = param
+      @prefix = prefix
+    end
+
+    def call
+      "#{@prefix}_#{@param}"
+    end
+  end
+end

data/lib/friendly_routes/services/prefixed_params.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FriendlyRoutes
+  class PrefixedParams
+    def initialize(params, prefix)
+      @params = params
+      @prefix = prefix
+    end
+
+    def call
+      mapped.join('/')
+    end
+
+    private
+
+    def mapped
+      @params.map do |param|
+        if param.is_a?(FriendlyRoutes::Params::Base)
+          name = PrefixedParam.new(param.name, @prefix).call
+          param.optional? ? "(:#{name})" : ":#{name}"
+        else
+          param
+        end
+      end
+    end
+  end
+end

data/lib/friendly_routes/version.rb

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

data/lib/friendly_routes.rb

@@ -2,11 +2,15 @@
 
 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'
+require 'friendly_routes/params/boolean_params'
+require 'friendly_routes/params/collection_params'
+require 'friendly_routes/params/hash_params'
+require 'friendly_routes/services/constraints'
+require 'friendly_routes/services/parser'
+require 'friendly_routes/services/prefixed_param'
+require 'friendly_routes/services/prefixed_params'
 
 module FriendlyRoutes
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_routes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roman Gritsay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -143,10 +143,14 @@ files:
 - 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/params/boolean_params.rb
+- lib/friendly_routes/params/collection_params.rb
+- lib/friendly_routes/params/hash_params.rb
 - lib/friendly_routes/route.rb
+- lib/friendly_routes/services/constraints.rb
+- lib/friendly_routes/services/parser.rb
+- lib/friendly_routes/services/prefixed_param.rb
+- lib/friendly_routes/services/prefixed_params.rb
 - lib/friendly_routes/version.rb
 homepage: https://github.com/RoM4iK/friendly_routes
 licenses: