rails-dsl 0.3.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01f607ff8fd5ab8b6495e6ebdac3a4543115108a
-  data.tar.gz: 69e2fe3545fbe251df679ea8950c9669beae733e
+  metadata.gz: e002eeafc2ccfe491ccb4c9f159e88086a35a510
+  data.tar.gz: 1d972d46a8325b825d544781d2ef61b232b55408
 SHA512:
-  metadata.gz: 6d738c5f7a6d362c84d168ec7259c7b3349433ea699e99d5a08bac08433d7ba1b72a429b73298cbfbe3884eae916c7f5639b726ae5ee6409d939d032c0d51c10
-  data.tar.gz: 6552d5ba39ecb756a58588bceba05e6c1c66b76e75be2656301521d01549f51a73576d99aa4afabaf8a582446bbbf3e31810cfd6572121f360643c97445d12fe
+  metadata.gz: 1628d1b0e72ddd6714c076e3b4eeb181d4a89d7490a0ce1736b2df6b1cb6d3b452c9284f6ae4787713ce5015d1a901258369121028ad2cbd5170d53e40c5faf6
+  data.tar.gz: b5c0ca8fef074376e9903610c36e2d2ab6efc1403d282e37e8fd1f21bf7ead550015cb3f2523bd02643f3a321f1fee1c40f7db7aa732352a332c1284eef7f818

data/README.md

@@ -21,7 +21,9 @@ if you call rails with 'kill' / 'k' command from now on, it will kill the applic
 
 ### Routing
 
-#### mount controller
+#### Mount controller
+
+##### As pages
 
 * mount a controller public methods as routes.
 * the method name will be the path
@@ -61,4 +63,63 @@ you can use the following options (name: [aliases])
 
     #> mount not private methods from PagesController
 
+```
+
+##### As API behavor
+
+in this mount options
+
+* the methods return value will be sent back parsed object to the requester
+* you dont have to set up render options
+
+* arguments will be parsed into route :params so the othere side can cache based on url
+    * the method actualy receive the passed parameter so you can use like in the example
+
+* by extend the method name you can set the methods REST method by the followind endings:
+    * _get
+    * _post
+    * _put
+    * _delete
+
+```ruby
+
+
+    #> controller
+    class PagesController < ApplicationController
+
+      #> this generate /test1/:hello.:format  path
+      def test1 hello
+        {hello: hello }
+      end
+
+      #> this generate /test2/:hello.:format  path
+      def test2
+        {hello: 'hello' }
+      end
+
+      def test2_post
+        {hello: 'blabla' }
+      end
+      #> POST /test.:format -> default json
+
+    end
+
+    #> routes.rb
+
+    HeartShoot::Application.routes.draw do
+
+      # you can still use the Class name too
+      mount_controller_as_api :pages
+
+      # or as alias
+      mount_api :pages
+
+      # or you can use well defaults key to set up parameters
+      # if you prefer the XML as default over JSON output
+      mount_api :pages, defaults: { format: :xml }
+
+    end
+
+    #> mount not private methods as apit from PagesController
+
 ```

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.4.1

data/lib/rails-dsl/routes_ext.rb

@@ -6,6 +6,28 @@ module Rails
       module Helpers
         class << self
 
+          def array_to_url_params array,method_name
+
+            return "" unless array.class <= ::Array
+
+            var=nil
+            array.each do |ary|
+
+              if ary[0].to_s == method_name.to_s
+                var = ary[1]
+                break
+              end
+
+            end
+
+            if !var.nil?
+              return "/:#{var.join('/:')}"
+            else
+              return ""
+            end
+
+          end
+
           def process_args *args
 
             opts= args.select{|e|(e.class <= ::Hash)}.reduce( {}, :merge! )
@@ -13,9 +35,12 @@ module Rails
             # search for alt keys
             {
 
-                scope:    [:s,:namespace,:path],
+                urls:     [:p,:paths,:url,:u],
+                scope:    [:s],
                 resource: [:r,:class],
                 defaults: [:d,:default],
+                params:   [:url_params],
+                ne:       [:exception,:exceptions,:ex],
 
                 get:      [:read],
                 post:     [:create],
@@ -32,14 +57,57 @@ module Rails
             opts[:defaults] ||= {}
             opts[:resource] ||= args.select{|e|([::Class,::String,::Symbol].include?(e.class))}[0]
 
+            opts[:params]   ||= args.select{|e|(e.class <= ::Array)}
+            opts[:params]   ||= []
+
+            opts[:urls]     ||= {}
+            opts[:ne]       ||= []
+
+            opts[:ne].map!{|method_name_to_sym| method_name_to_sym.to_s.to_sym }
+
             [:get,:post,:put,:delete,:options].each{|sym| opts[sym] ||= [] ; opts[sym]= [opts[sym]]  unless opts[sym].class <= ::Array }
 
+            unless opts[:params].class <= ::Array
+              raise(ArgumentError,"invalid argument for url params: #{opts[:params]}.\nmust be something like [:method_name,[:url_params]] || [:method_name,:url_params]")
+            end
+
+            unless opts[:urls].class <= ::Hash
+              raise(ArgumentError,"invalid argument for urls group: #{opts[:urls]}.\nmust be something like {method_name: '/path'}")
+            end
+
+            unless opts[:params].empty?
+
+              opts[:params].each{|ary| raise unless ary.size == 2 }
+              opts[:params].each{|ary| ary[1]= [ary[1]] unless ary[1].class <= ::Array }
+
+            end
+
             # validations
             raise(ArgumentError,"Invalid defaults given") unless opts[:defaults].class <= ::Hash
 
             opts[:short_class_name]= opts[:resource].to_s.underscore.split('_')[0]
-            opts[:class]      = ( opts[:resource].class == Class ? opts[:resource] : opts[:resource].to_s.concat('_controller').classify.constantize )
+            opts[:class] = ( opts[:resource].class == Class ? opts[:resource] : opts[:resource].to_s.concat('_controller').classify.constantize )
+            opts[:pim] = opts[:class].public_instance_methods(false).select{|e|(e.to_s.last != '?')} - opts[:ne]
+
+            # make setup able method configs
+            opts[:pim].each do |sym|
+
+              sym_str= sym.to_s
+              {
+                  get:    /_get$/,
+                  post:   /_post$/,
+                  put:    /_put$/,
+                  delete: /_delete$/
+              }.each do |type,regex|
+
+                if sym_str =~ regex
+                  opts[type].push(sym)
+                  opts[:urls][sym] ||= "/#{sym_str.gsub(regex,"")}"
+                end
+
+              end
 
+            end
 
             return opts
 
@@ -51,13 +119,18 @@ module Rails
 
       def mount_controller *args
 
-        opts= Rails::DSL::ActionDispatchRouteEXT::Helpers.process_args(*args)
+        opts= nil
+        if args.size == 1 && args[0].class <= ::Hash
+          opts= args[0]
+        else
+          opts= Rails::DSL::ActionDispatchRouteEXT::Helpers.process_args(*args)
+        end
 
         # helper lambdas
 
         create_mapping= lambda do
 
-          opts[:class].public_instance_methods(false).each do |method_name|
+          opts[:pim].each do |method_name|
 
             method_to_use= nil
             [:get,:post,:put,:delete,:options].each do |pre_spec_method_call_type|
@@ -67,7 +140,11 @@ module Rails
             end
             method_to_use ||= :get
 
-            self.__send__ method_to_use,"/#{method_name}",{to: "#{opts[:short_class_name]}##{method_name}"}.merge({defaults: opts[:defaults]})
+            url_path = opts[:urls][method_name].nil? ? "/#{method_name}" : opts[:urls][method_name].to_s
+
+            self.__send__ method_to_use,
+                          "#{url_path}#{Rails::DSL::ActionDispatchRouteEXT::Helpers.array_to_url_params(opts[:params],method_name)}",
+                          {to: "#{opts[:short_class_name]}##{method_name}", defaults: opts[:defaults].dup }
 
           end
 
@@ -82,20 +159,51 @@ module Rails
           create_mapping.call
         end
 
+        return nil
+
       end
 
-      # def mount_controller_api *args
-      #   opts= Rails::DSL::ActionDispatchRouteEXT::Helpers.process_args(*args)
-      #
-      #   # respond_to do |format|
-      #   #   format.html
-      #   #   format.json{
-      #   #     render :json => {hello: 'world'}
-      #   #   }
-      #   # end
-      #
-      # end
-      # alias mount_controller_as_api mount_controller_api
+      def mount_controller_as_api *args
+
+        opts= Rails::DSL::ActionDispatchRouteEXT::Helpers.process_args(*args)
+        conv_params= []
+
+        # make last value return as value object rendered as the specific format
+        opts[:class].class_eval do
+
+          opts[:pim].each do |sym|
+
+            var= self.instance_method(sym)
+            parameters= []
+
+            unless var.parameters.select{|ary|(ary[0] ==:req)}.empty?
+              parameters += var.parameters.select{|ary|(ary[0] ==:req)}.map{|ary| ary[1] }
+              conv_params.push [ sym, parameters ]
+            end
+
+            define_method(sym) do
+
+              value= var.bind(self).call(*parameters.map{ |param_key| params[param_key] })
+
+              respond_to do |format|
+                format.html
+                format.json { render json:  value }
+                format.xml  { render xml:   value }
+              end
+
+            end
+
+          end
+
+        end
+
+        # mount controller methods
+        mount_controller *args,*conv_params, { defaults: {format: :json} }
+
+        return nil
+
+      end
+      alias mount_api mount_controller_as_api
 
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-dsl
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Adam Luzsi