shaf 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fa1ac79ab7ea9af45c8d160116ab1aee7ed964254927fe9045664930405e2c6
-  data.tar.gz: bf9dc19468e7b25d5e0c94c8484558f89bd6ec84e47d4d00211c3d57029909fc
+  metadata.gz: 9123190de71ec1df3a8c53c32a8f7e26a72b42bf6255fe2e0613cd0ee5f15837
+  data.tar.gz: 53f39cd9d1283771a638a4f1a53f85e79e9f329b0dacb8f7dd3ce08ed54d8199
 SHA512:
-  metadata.gz: d383a3b23dd5675fc3683a8b2c76407bcc9cf25ff17eb699b4cbd75898d053fdd1d1a2b8fb522eedf4fe8c7330a726dfc126d39508ce7c50c0a211b0ba6e8a86
-  data.tar.gz: f03870ee03fdc20f04541c9bff9cde8a1d2fa1ef3b1a0a0a52b0a20724cee752a5abe3b6f5eb5ec330125c010f8bc1f85acd9e18eaa3f97884ff33d66fe087ea
+  metadata.gz: 9713237dc988ae3a336016338ad711d59766533a68f88db7bbec9da70ac349906f779abef11cf8e9fb3b3865b652120cc756f8a0bd6558d0a7406405b7122ee6
+  data.tar.gz: 5f80c980f49450f27e1b17b3a13b1d3b724c43c7ae75c297cce54807b1a2a99920159171be152da6dd0fa6d7c239dd0e1e42d4cd08307c3d91f393f730ec5038

data/lib/shaf/extensions.rb

@@ -1,4 +1,5 @@
 require 'shaf/extensions/resource_uris'
+require 'shaf/extensions/controller_hooks'
 require 'shaf/extensions/current_user'
 require 'shaf/extensions/authorize'
 require 'shaf/extensions/symbolic_routes'
@@ -7,6 +8,7 @@ module Shaf
   def self.extensions
     [
       ResourceUris,
+      ControllerHooks,
       CurrentUser,
       Authorize,
       SymbolicRoutes

data/lib/shaf/extensions/controller_hooks.rb

@@ -0,0 +1,47 @@
+require 'sinatra/base'
+
+module Shaf
+  module ControllerHooks
+    def before_action(method_name = nil, **options, &block)
+      __action_hook(:before, method_name, block, options)
+    end
+
+    def after_action(method_name = nil, **options, &block)
+      __action_hook(:after, method_name, block, options)
+    end
+
+    private
+
+    def __action_hook(hook, method_name, block, **options)
+      only = Array(options[:only]) if options.key? :only
+      except = Array(options[:except]) if options.key? :except
+
+      path_helpers.each do |helper|
+        next if only && !only.include?(helper)
+        next if except&.include? helper
+        pattern = __path_pattern(helper)
+
+        if method_name
+          send(hook, pattern) { send(method_name) }
+        elsif block
+          send(hook, pattern, &block)
+        else
+          log.warn <<~RUBY
+            #{hook}_action without block (options: #{options}).
+            Specify method or pass a block!
+          RUBY
+        end
+      end
+    end
+
+    def __path_pattern(path_helper)
+      uri_helper = path_helper.to_s.sub(/path\Z/, 'uri')
+      template_method = "#{uri_helper}_template".to_sym
+      template = send template_method
+      str = template.gsub(%r{:[^/]*}, '\w+')
+      Regexp.new("#{str}/?")
+    end
+  end
+
+  Sinatra.register ControllerHooks
+end

data/lib/shaf/extensions/resource_uris.rb

@@ -2,14 +2,25 @@ require 'sinatra/base'
 
 module Shaf
   module ResourceUris
+    class UriHelperMethodAlreadyExistError < Error
+      def initialize(resource_name, method_name)
+        super(
+          "resource uri #{resource_name} can't be registered. " \
+          "Method :#{method_name} already exist!"
+        )
+      end
+    end
+
     def resource_uris_for(*args)
-      CreateUriMethods.new(*args).call
+      result = CreateUriMethods.new(*args).call
+      UriHelperMethods.add_path_helpers(self, result)
 
       include UriHelper unless self < UriHelper
     end
 
     def register_uri(name, uri)
-      MethodBuilder.new(name, uri).call
+      result = MethodBuilder.new(name, uri).call
+      UriHelperMethods.add_path_helpers(self, result)
 
       include UriHelper unless self < UriHelper
     end
@@ -18,12 +29,39 @@ module Shaf
   Sinatra.register ResourceUris
 
   module UriHelperMethods
-    def self.register(name, &block)
-      define_method(name, &block)
+    class << self
+      def register(name, &block)
+        define_method(name, &block)
+      end
+
+      def eval_method(str)
+        class_eval str
+      end
+
+      def add_path_helpers(clazz, methods)
+        @path_helpers ||= {}
+        @path_helpers[clazz] ||= []
+        @path_helpers[clazz].concat Array(methods)
+      end
+
+      def path_helpers_for(clazz = nil)
+        @path_helpers ||= {}
+        return @path_helpers unless clazz
+        return [] unless @path_helpers.key?(clazz)
+        @path_helpers[clazz] ||= []
+      end
+
+      # For cleaning up after tests
+      def remove_all
+        helpers = instance_methods - [:path_helpers]
+        remove_method(*helpers)
+        @path_helpers = {}
+      end
     end
 
-    def self.eval_method(str)
-      class_eval str
+    def path_helpers
+      clazz = is_a?(Class) ? self : self.class
+      UriHelperMethods.path_helpers_for clazz
     end
   end
 
@@ -46,13 +84,13 @@ module Shaf
   # This class register uri helper methods like:
   # books_uri             => /books
   # book_uri(book)        => /books/5
-  # new_book_uri          => /books/form
+  # new_book_uri          => /book/form
   # edit_book_uri(book)   => /books/5/edit
   #
   # And uri template methods:
   # books_uri_template             => /books
   # book_uri_template              => /books/:id
-  # new_book_uri_template          => /books/form
+  # new_book_uri_template          => /book/form
   # edit_book_uri_template         => /books/:id/edit
   #
   class CreateUriMethods
@@ -61,6 +99,7 @@ module Shaf
       @name = name.to_s
       @base = base&.sub(%r(/\Z), '') || ''
       @plural_name = plural_name&.to_s || Utils::pluralize(name.to_s)
+      @added_path_methods = []
     end
 
     def call
@@ -72,6 +111,7 @@ module Shaf
       end
       register_new_resource_uri
       register_edit_resource_uri
+      @added_path_methods
     end
 
     private
@@ -95,11 +135,12 @@ module Shaf
       resource_template_uri =   "#{base}/#{plural_name}/:id"
       collection_template_uri = "#{base}/#{plural_name}"
 
-      MethodBuilder.new(name, resource_template_uri, alt_uri: collection_template_uri).call
+      builder = MethodBuilder.new(name, resource_template_uri, alt_uri: collection_template_uri)
+      @added_path_methods << builder.call
     end
 
     def register_new_resource_uri
-      template_uri = "#{base}/#{plural_name}/form".freeze
+      template_uri = "#{base}/#{name}/form".freeze
       register("new_#{name}", template_uri)
     end
 
@@ -109,7 +150,8 @@ module Shaf
     end
 
     def register(name, template_uri)
-      MethodBuilder.new(name, template_uri).call
+      builder = MethodBuilder.new(name, template_uri)
+      @added_path_methods << builder.call
     end
   end
 
@@ -127,8 +169,8 @@ module Shaf
 
     def call
       if UriHelper.respond_to? uri_method_name
-        raise "resource uri #{@name} can't be registered. " \
-          "Method :#{uri_method_name} already exist!"
+        exception = ResourceUris::UriHelperMethodAlreadyExistError
+        raise exception.new(@name, uri_method_name)
       end
 
       if @alt_uri.nil?
@@ -144,12 +186,18 @@ module Shaf
       UriHelperMethods.eval_method uri_method_string
       UriHelperMethods.eval_method path_method_string
       UriHelperMethods.register(template_method_name, &template_proc)
+      UriHelperMethods.register(legacy_template_method_name, &template_proc)
+      UriHelperMethods.register(path_matcher_name, &path_matcher_proc)
+      path_method_name.to_sym
     end
 
     def build_methods_with_optional_arg
       UriHelperMethods.eval_method uri_method_with_optional_arg_string
       UriHelperMethods.eval_method path_method_with_optional_arg_string
       UriHelperMethods.register(template_method_name, &template_proc)
+      UriHelperMethods.register(legacy_template_method_name, &template_proc)
+      UriHelperMethods.register(path_matcher_name, &path_matcher_proc)
+      path_method_name.to_sym
     end
 
     def uri_method_name
@@ -160,7 +208,15 @@ module Shaf
       "#{@name}_path".freeze
     end
 
+    def path_matcher_name
+      :"#{path_method_name}?"
+    end
+
     def template_method_name
+      "#{path_method_name}_template".freeze
+    end
+
+    def legacy_template_method_name
       "#{uri_method_name}_template".freeze
     end
 
@@ -268,5 +324,32 @@ module Shaf
         ->(collection = false) { collection ? alt_uri : uri }
       end
     end
+
+    def path_mather_patterns
+      [
+        @uri.gsub(%r{:[^/]*}, '\w+'),
+        @alt_uri&.gsub(%r{:[^/]*}, '\w+')
+      ].compact.map { |str| Regexp.new("\\A#{str}\\Z") }
+    end
+
+    def path_matcher_proc
+      patterns = path_mather_patterns
+
+      lambda do |path = nil, collection: false|
+        unless path
+          r = request if respond_to? :request
+          path = r.path_info if r&.respond_to? :path_info
+
+          unless path
+            raise(
+              ArgumentError,
+              "Uri must be given (or #{self} should respond to :request)"
+            )
+          end
+        end
+        pattern = collection ? patterns.last : patterns.first
+        !!(pattern =~ path)
+      end
+    end
   end
 end

data/lib/shaf/formable/field.rb

@@ -8,13 +8,13 @@ module Shaf
       immutable_reader :name, :type, :value, :label, :required
 
       HTML_TYPE_MAPPINGS = {
-        'string' => 'text',
-        'boolean' => 'checkbox',
+        string: 'text',
+        boolean: 'checkbox'
       }.freeze
 
       def initialize(name, params = {})
         @name = name
-        @type = params[:type]
+        @type = params[:type]&.to_sym
         @label = params[:label]
         @has_value = params.key? :value
         @value = params[:value]

data/lib/shaf/formable/form.rb

@@ -69,7 +69,7 @@ module Shaf
       private
 
       def name_from(action)
-        :"#{action}-form" if action
+        :"#{action.to_s.tr('_', '-')}-form" if action
       end
 
       def http_method_from(action)

data/lib/shaf/generator/templates/api/controller.rb.erb

@@ -6,43 +6,43 @@ class <%= controller_class_name %> < BaseController
 
   resource_uris_for :<%= name %>
 
-  get :<%= plural_name %>_uri do
+  get :<%= plural_name %>_path do
     authorize! :read
     collection = paginate(<%= model_class_name %>.order(:created_at).reverse)
     respond_with_collection collection, serializer: <%= serializer_class_name %>
   end
 
-  get :new_<%= name %>_uri do
+  get :new_<%= name %>_path do
     authorize! :read
     cache_control(:private, http_cache_max_age: :short)
     respond_with create_form
   end
 
-  post :<%= plural_name %>_uri do
+  post :<%= plural_name %>_path do
     authorize! :write
     <%= name %> = <%= model_class_name %>.create(<%= name %>_params)
     headers({ "Location" => <%= name %>_uri(<%= name %>) })
     respond_with <%= name %>, status: 201
   end
 
-  get :<%= name %>_uri do
+  get :<%= name %>_path do
     authorize! :read
     respond_with <%= name %>
   end
 
-  get :edit_<%= name %>_uri do
+  get :edit_<%= name %>_path do
     authorize! :read
     cache_control(:private, http_cache_max_age: :short)
     respond_with edit_form
   end
 
-  put :<%= name %>_uri do
+  put :<%= name %>_path do
     authorize! :write
     <%= name %>.update(<%= name %>_params)
     respond_with <%= name %>
   end
 
-  delete :<%= name %>_uri do
+  delete :<%= name %>_path do
     authorize! :write
     <%= name %>.destroy
     status 204

data/lib/shaf/generator/templates/spec/integration_spec.rb.erb

@@ -30,7 +30,7 @@ describe <%= model_class_name %>, type: :integration do
 <% end -%>
     end
   end
-
+<% if params.size > 0 %>
   it "can create <%= plural_name %>" do
     get <%= plural_name %>_uri
 
@@ -88,6 +88,7 @@ describe <%= model_class_name %>, type: :integration do
     status.must_equal 200
     link_rels.must_include(:self)
   end
+<% end -%>
 
   it "<%= plural_name %> can be deleted" do
     <%= name %> = <%= model_class_name %>.create

data/lib/shaf/tasks.rb

@@ -1,6 +1,7 @@
 require 'shaf/tasks/test_task'
 require 'shaf/tasks/db_task'
 require 'shaf/tasks/api_doc_task'
+require 'shaf/tasks/routes_task'
 
 module Shaf
   include Tasks # includes task classes rather than methods

data/lib/shaf/tasks/routes_task.rb

@@ -0,0 +1,28 @@
+module Shaf
+  module Tasks
+    class RoutesTask
+      include Rake::DSL
+
+      def initialize(*)
+        desc "List path helpers"
+        task :routes do
+          require 'shaf/utils'
+          require 'config/database'
+
+          extend Shaf::Utils
+          bootstrap
+
+          UriHelperMethods.path_helpers_for.each do |controller, methods|
+            puts "\n#{controller}:"
+            methods.each do |method|
+              template_method = "#{method}_template".to_sym
+              puts sprintf( "%-60s%s" , method, controller.send(template_method))
+            end
+          end
+        end
+      end
+    end
+
+    RoutesTask.new
+  end
+end

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -133,6 +133,7 @@ files:
 - lib/shaf/errors.rb
 - lib/shaf/extensions.rb
 - lib/shaf/extensions/authorize.rb
+- lib/shaf/extensions/controller_hooks.rb
 - lib/shaf/extensions/current_user.rb
 - lib/shaf/extensions/resource_uris.rb
 - lib/shaf/extensions/symbolic_routes.rb
@@ -188,6 +189,7 @@ files:
 - lib/shaf/tasks.rb
 - lib/shaf/tasks/api_doc_task.rb
 - lib/shaf/tasks/db_task.rb
+- lib/shaf/tasks/routes_task.rb
 - lib/shaf/tasks/test_task.rb
 - lib/shaf/upgrade.rb
 - lib/shaf/upgrade/manifest.rb