shaf 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff5e3dc188a76a89a8b4443f3996e61486a6836b91978b0fae3cd5adb9e88296
-  data.tar.gz: bbc13631ee68eeef0b86edd050602b625f001d070a3f704d3915b20ce015149e
+  metadata.gz: d9eb918ad2c43059ac408c1bd9d85e41e3c3914510a22ed08628ffc9984f1777
+  data.tar.gz: b7f1593151ad34cac7e0edde0841cde9dc3494f72d1292835814870b733681f8
 SHA512:
-  metadata.gz: 65f87a51936f02635793ecb730d211563950c3953cd08b967094d2586b2b1f8bf725e87b6f100b3a61c45c36070fd3a69f2e6b0916185f9c935ae333b10bd89f
-  data.tar.gz: ad411b694fe94039f6577d7e934944054657572feeef49abc4557dec4b726a3e9cd71940ae66cfbe52c6de390cecedfa80d107207e1016d50e5dedda2c524297
+  metadata.gz: 6b76e3caf4a9e844b7c40e97e56ef37b332db9b3466efb585ad786dbbd7461f22b3b9088c758df2313eef3fcd2832ef880419f4b322ce63063861f4db8ed72fb
+  data.tar.gz: 6818d566651548ff3e8244e87fc98263b4ba52cffb728618a4c0c8822e20a9f043633ee9b4d6e1c8bbd443354f3de1c753f1ecc7255631cf5036c46560565d9e

data/lib/shaf/app.rb

@@ -4,14 +4,14 @@ module Shaf
   class App
     class << self
       def instance
-        create_instance unless defined?(@instance)
-        @instance
+        @instance ||= create_instance
       end
 
       def create_instance
-        @instance = Sinatra.new
-        @instance.set :port, Settings.port || 3000
-        @instance.use Shaf::Middleware::RequestId
+        Sinatra.new.tap do |instance|
+          instance.set :port, Settings.port || 3000
+          instance.use Shaf::Middleware::RequestId
+        end
       end
 
       def use(middleware)

data/lib/shaf/command/new.rb

@@ -40,7 +40,7 @@ module Shaf
 
       def erb(content)
         return ERB.new(content, 0, '%-<>').result if RUBY_VERSION < "2.6.0"
-        ERB.new(content, 0, trim_mode: '%-<>').result
+        ERB.new(content, trim_mode: '-<>').result
       end
 
       def copy_templates

data/lib/shaf/extensions/resource_uris.rb

@@ -11,8 +11,8 @@ module Shaf
       end
     end
 
-    def resource_uris_for(*args)
-      result = CreateUriMethods.new(*args).call
+    def resource_uris_for(name, **kwargs)
+      result = CreateUriMethods.new(name, **kwargs).call
       UriHelperMethods.add_path_helpers(self, result)
 
       include UriHelper unless self < UriHelper
@@ -94,36 +94,41 @@ module Shaf
   # edit_book_uri_template         => /books/:id/edit
   #
   class CreateUriMethods
-
-    def initialize(name, base: nil, plural_name: nil)
+    def initialize(name, base: nil, plural_name: nil, only: nil, except: nil)
       @name = name.to_s
       @base = base&.sub(%r(/\Z), '') || ''
       @plural_name = plural_name&.to_s || Utils::pluralize(name.to_s)
+      @only = only
+      @except = except
       @added_path_methods = []
     end
 
     def call
       if plural_name == name
-        register_resource_uri_by_arg
+        register_resource_helper_by_arg
       else
-        register_resources_uri
-        register_resource_uri
+        register_collection_helper
+        register_resource_helper
       end
-      register_new_resource_uri
-      register_edit_resource_uri
+      register_new_resource_helper
+      register_edit_resource_helper
       @added_path_methods
     end
 
     private
 
-    attr_reader :name, :base, :plural_name
+    attr_reader :name, :base, :plural_name, :only, :except
+
+    def register_collection_helper
+      return if skip? :collection
 
-    def register_resources_uri
       template_uri = "#{base}/#{plural_name}".freeze
       register(plural_name, template_uri)
     end
 
-    def register_resource_uri
+    def register_resource_helper
+      return if skip? :resource
+
       template_uri = "#{base}/#{plural_name}/:id".freeze
       register(name, template_uri)
     end
@@ -131,7 +136,10 @@ module Shaf
     # If a resource has the same singular and plural names, then this method
     # should be used. It will return the resource uri when a resource is given
     # as argument and the resources uri when no arguments are provided.
-    def register_resource_uri_by_arg
+    def register_resource_helper_by_arg
+      return register_resource_helper if skip? :collection
+      return register_collection_helper if skip? :new
+
       resource_template_uri =   "#{base}/#{plural_name}/:id"
       collection_template_uri = "#{base}/#{plural_name}"
 
@@ -139,12 +147,16 @@ module Shaf
       @added_path_methods << builder.call
     end
 
-    def register_new_resource_uri
+    def register_new_resource_helper
+      return if skip? :new
+
       template_uri = "#{base}/#{name}/form".freeze
       register("new_#{name}", template_uri)
     end
 
-    def register_edit_resource_uri
+    def register_edit_resource_helper
+      return if skip? :edit
+
       template_uri = "#{base}/#{plural_name}/:id/edit".freeze
       register("edit_#{name}", template_uri)
     end
@@ -153,6 +165,16 @@ module Shaf
       builder = MethodBuilder.new(name, template_uri)
       @added_path_methods << builder.call
     end
+
+    def skip? name
+      if only
+        !Array(only).include? name
+      elsif except
+        Array(except).include? name
+      else
+        false
+      end
+    end
   end
 
   class MethodBuilder

data/lib/shaf/formable/builder.rb

@@ -4,7 +4,7 @@ module Shaf
   module Formable
     class Builder
       InstanceAccessorType = Struct.new(:prefill?)
-      DELEGATES = %i[title name action method type fields].freeze
+      DELEGATES = %i[title name action method type submit fields].freeze
 
       attr_reader :forms
 
@@ -42,7 +42,7 @@ module Shaf
 
       DELEGATES.each do |name|
         define_method(name) do |arg|
-          form.send("#{name}=".to_sym, arg)
+          form.send(:"#{name}=", arg)
         end
       end
 

data/lib/shaf/formable/form.rb

@@ -9,9 +9,10 @@ module Shaf
       class FormHasNoResourceError < Shaf::Error; end
 
       DEFAULT_TYPE = 'application/json'.freeze
+      DEFAULT_SUBMIT = 'save'.freeze
 
       attr_accessor :resource
-      immutable_accessor :title, :name, :href, :type, :self_link
+      immutable_accessor :title, :name, :href, :type, :submit, :self_link
       immutable_reader :fields, :action
 
       def initialize(params = {})
@@ -20,6 +21,7 @@ module Shaf
         @name = params[:name]&.to_sym || name_from(@action)
         @method = params[:method] ||= http_method_from(@action)
         @type = params[:type] || DEFAULT_TYPE
+        @submit = params[:submit] || DEFAULT_SUBMIT
         @fields = (params[:fields] || {}).map do |name, args|
           Field.new(name, args)
         end

data/lib/shaf/generator/base.rb

@@ -47,7 +47,7 @@ module Shaf
         b = OpenStruct.new(locals).instance_eval { binding }
 
         return ERB.new(str, 0, '%-<>').result(b) if RUBY_VERSION < "2.6.0"
-        ERB.new(str, 0, trim_mode: '%-<>').result(b)
+        ERB.new(str,trim_mode: '-<>').result(b)
       rescue SystemCallError => e
         puts "Failed to render template #{template}: #{e.message}"
         raise

data/lib/shaf/generator/migration/base.rb

@@ -1,37 +1,10 @@
 require 'date'
+require 'shaf/generator/migration/types'
 
 module Shaf
   module Generator
     module Migration
       class Base
-        DB_COL_FORMAT_STRINGS = {
-          integer:    ['Integer :%s',             'add_column :%s, Integer'],
-          varchar:    ['String %s',               'add_column :%s, String'],
-          string:     ['String :%s',              'add_column :%s, String'],
-          text:       ['String :%s, text: true',  'add_column :%s, String, text: true'],
-          blob:       ['File :%s',                'add_column :%s, File'],
-          bigint:     ['Bignum :%s',              'add_column :%s, Bignum'],
-          double:     ['Float :%s',               'add_column :%s, Float'],
-          numeric:    ['BigDecimal :%s',          'add_column :%s, BigDecimal'],
-          date:       ['Date :%s',                'add_column :%s, Date'],
-          timestamp:  ['DateTime :%s',            'add_column :%s, DateTime'],
-          time:       ['Time :%s',                'add_column :%s, Time'],
-          bool:       ['TrueClass :%s',           'add_column :%s, TrueClass'],
-          boolean:    ['TrueClass :%s',           'add_column :%s, TrueClass'],
-          index:      ['index :%s, unique: true', 'add_index :%s'],
-        }
-
-        COMPLEX_DB_TYPES = [
-          {
-            pattern: /\Aforeign_key\((\w+)\)/,
-            strings: ['foreign_key :%s, :\1',     'add_foreign_key :%s, :\1'],
-            validator: ->(type, match) {
-              break if ::DB.table_exists?(match[1])
-              ["Foreign key table '#{match[1]}' does not exist!"]
-            }
-          }
-        ]
-
         attr_reader :args, :options
 
         class << self
@@ -68,9 +41,10 @@ module Shaf
         end
 
         def column_def(str, create: true)
-          name, type = str.split(':')
-          format_string = db_format_string(type, create ? 0 : 1)
-          format format_string, name.downcase
+          _, col_type = str.split(':')
+          type = Type.find(col_type)
+          raise "No supported DB column types for: #{col_type}" unless type
+          type.build(str, create: create, alter: !create)
         end
 
         def target(name)
@@ -91,32 +65,6 @@ module Shaf
           end
         end
 
-        def db_format_string(type, range = 0..1)
-          type ||= :string
-          result = DB_COL_FORMAT_STRINGS[type.to_sym]
-          result ||= regexp_db_format_string(type)
-          raise "Column type '#{type}' not supported" unless result
-          result[range]
-        end
-
-        def regexp_db_format_string(type)
-          COMPLEX_DB_TYPES.find do |complex_type|
-            match = complex_type[:pattern].match(type) or next
-            validator = complex_type[:validator]
-            errors = validator&.call(type, match)
-            raise "Failed to process '#{type}': #{errors&.join(', ')}" unless Array(errors).empty?
-
-            break complex_type[:strings].map { |s| replace_backreferences(match, s) }
-          end
-        end
-
-        def replace_backreferences(match, str)
-          groups = match.size
-          (1...groups).inject(str) do |s, i|
-            s.gsub("\\#{i}", match[i])
-          end
-        end
-
         def render
           <<~RUBY
             Sequel.migration do

data/lib/shaf/generator/migration/type.rb

@@ -0,0 +1,88 @@
+module Shaf
+  module Generator
+    module Migration
+      class Type
+        attr_reader :name, :create_template, :alter_template, :validator
+
+        class << self
+          def add(name, **kwargs)
+            new(name, **kwargs).tap do |type|
+              types[type.name] = type
+            end
+          end
+
+          def find(str)
+            name, _ = str.to_s.split(',', 2)
+            types[name.to_sym]
+          end
+
+          private
+
+          def types
+            @types ||= {}
+          end
+
+          def clear
+            @types.clear if defined? @types
+          end
+        end
+
+        def initialize(str, create_template:, alter_template:, validator: nil)
+          @name = str.downcase.to_sym
+          @create_template = create_template
+          @alter_template = alter_template
+          @validator = validator
+        end
+
+        def build(str, create: false, alter: false)
+          args = parse_args(str)
+          validate!(*args)
+
+          if create && !alter
+            build_create_string(*args)
+          elsif alter && !create
+            build_alter_string(*args)
+          else
+            [
+              build_create_string(*args),
+              build_alter_string(*args)
+            ]
+          end
+        end
+
+        def parse_args(str)
+          name, col_type  = str.to_s.downcase.split(':')
+          _, *args = col_type&.split(',')
+          args.unshift name
+        end
+
+        def build_create_string(*args)
+          format create_template, *args
+        rescue ArgumentError
+          raise Command::ArgumentError,
+            "Wrong number of arguments for type #{name} with string " \
+            "template '#{create_template}. Given: #{args}"
+        end
+
+        def build_alter_string(*args)
+          format alter_template, *args
+        rescue ArgumentError
+          raise Command::ArgumentError,
+            "Wrong number of arguments for type #{name} with string " \
+            "template '#{alter_template}. Given: #{args}"
+        end
+
+        def validate!(*args)
+          errors = Array(validator&.call(name, *args))
+          return if errors.empty?
+
+          raise "Failed to process '#{name}': #{errors&.join(', ')}"
+        end
+
+        def ==(other)
+          name == other.name
+        end
+      end
+    end
+  end
+end

data/lib/shaf/generator/migration/types.rb

@@ -0,0 +1,31 @@
+require 'shaf/generator/migration/type'
+
+module Shaf
+  module Generator
+    module Migration
+      Type.add :integer,        create_template: 'Integer :%s',                 alter_template: 'add_column :%s, Integer'
+      Type.add :varchar,        create_template: 'String %s',                   alter_template: 'add_column :%s, String'
+      Type.add :string,         create_template: 'String :%s',                  alter_template: 'add_column :%s, String'
+      Type.add :text,           create_template: 'String :%s, text: true',      alter_template: 'add_column :%s, String, text: true'
+      Type.add :blob,           create_template: 'File :%s',                    alter_template: 'add_column :%s, File'
+      Type.add :bigint,         create_template: 'Bignum :%s',                  alter_template: 'add_column :%s, Bignum'
+      Type.add :double,         create_template: 'Float :%s',                   alter_template: 'add_column :%s, Float'
+      Type.add :numeric,        create_template: 'BigDecimal :%s',              alter_template: 'add_column :%s, BigDecimal'
+      Type.add :date,           create_template: 'Date :%s',                    alter_template: 'add_column :%s, Date'
+      Type.add :timestamp,      create_template: 'DateTime :%s',                alter_template: 'add_column :%s, DateTime'
+      Type.add :time,           create_template: 'Time :%s',                    alter_template: 'add_column :%s, Time'
+      Type.add :bool,           create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
+      Type.add :boolean,        create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
+      Type.add :index,          create_template: 'index :%s, unique: true',     alter_template: 'add_index :%s'
+
+      Type.add :foreign_key,
+        create_template: 'foreign_key :%s, :%s',
+        alter_template: 'add_foreign_key :%s, :%s',
+        validator: ->(type, *args) {
+          table = args[1]
+          break if ::DB.table_exists?(table)
+          ["Foreign key table '#{table}' does not exist!"]
+        }
+    end
+  end
+end

data/lib/shaf/helpers/payload.rb

@@ -86,9 +86,9 @@ module Shaf
       status(status)
 
       preferred_response = preferred_response_type(resource)
-      serialized = serialize(resource, serializer, collection)
+      http_cache = kwargs.delete(:http_cache) { Settings.http_cache }
 
-      http_cache = kwargs.fetch(:http_cache, Settings.http_cache)
+      serialized = serialize(resource, serializer, collection, **kwargs)
       add_cache_headers(serialized) if http_cache
 
       log.info "#{request.request_method} #{request.path_info} => #{status}"
@@ -100,12 +100,12 @@ module Shaf
       end
     end
 
-    def serialize(resource, serializer, collection)
+    def serialize(resource, serializer, collection, **options)
       serializer ||= HALPresenter
       if collection
-        serializer.to_collection(resource, current_user: current_user)
+        serializer.to_collection(resource, current_user: current_user, **options)
       else
-        serializer.to_hal(resource, current_user: current_user)
+        serializer.to_hal(resource, current_user: current_user, **options)
       end
     end
 

data/lib/shaf/immutable_attr.rb

@@ -34,18 +34,8 @@ module Shaf
     end
 
     def immutable_accessor(*methods)
-      methods.each do |method|
-        define_method(method) do
-          value = instance_variable_get(:"@#{method}")
-          ImmutableAttr.dup(value)
-        end
-        define_method(:"#{method}=") do |value|
-          instance_variable_set(
-            :"@#{method}",
-            ImmutableAttr.dup(value)
-          )
-        end
-      end
+      immutable_reader(*methods)
+      immutable_writer(*methods)
     end
   end
 end

data/lib/shaf/tasks/routes_task.rb

@@ -12,7 +12,8 @@ module Shaf
           extend Shaf::Utils
           bootstrap
 
-          UriHelperMethods.path_helpers_for.each do |controller, methods|
+          helpers = UriHelperMethods.path_helpers_for.sort { |a, b| a[0].to_s <=> b[0].to_s }
+          helpers.each do |controller, methods|
             puts "\n#{controller}:"
             methods.each do |method|
               template_method = "#{method}_template".to_sym

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/templates/config/bootstrap.rb

@@ -7,6 +7,5 @@ require 'shaf/settings'
 require 'config/constants'
 require 'config/database'
 require 'config/initializers'
-require 'api/controllers/base_controller'
 require 'config/directories'
 require 'config/helpers'

data/templates/config/constants.rb

@@ -1,6 +1,7 @@
 APP_ROOT = File.expand_path('../', __dir__)
 APP_DIR = File.expand_path('api', APP_ROOT)
 SRC_DIR = File.expand_path('src', APP_ROOT)
+LIB_DIR = File.expand_path('lib', APP_ROOT)
 VIEWS_DIR = File.join(APP_ROOT, Shaf::Settings.views_folder)
 ASSETS_DIR = File.join(APP_ROOT, Shaf::Settings.public_folder)
 AUTH_TOKEN_HEADER = 'HTTP_X_AUTH_TOKEN'

data/templates/config/directories.rb

@@ -1,7 +1,5 @@
 require 'config/constants'
 
-$:.unshift APP_DIR
-
 def sort_files(files)
   files.sort_by do |file|
     directory_priority(file) + file_priority(file)
@@ -27,7 +25,6 @@ def directory_priority(file)
   end
 end
 
-
 def file_priority(file)
   case File.basename(file)
   when /\Abase[\._]/
@@ -46,15 +43,11 @@ def require_ruby_files
   end
 end
 
-if Dir.exist? SRC_DIR
-  $:.unshift SRC_DIR
+[LIB_DIR, SRC_DIR, APP_DIR].each do |dir|
+  next unless Dir.exist? dir
+  $LOAD_PATH.unshift dir
 
-  Dir.chdir(SRC_DIR) do
+  Dir.chdir(dir) do
     require_ruby_files
   end
 end
-
-Dir.chdir(APP_DIR) do
-  require_ruby_files
-end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2019-01-05 00:00:00.000000000 Z
+date: 2019-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -152,6 +152,8 @@ files:
 - lib/shaf/generator/migration/drop_column.rb
 - lib/shaf/generator/migration/empty.rb
 - lib/shaf/generator/migration/rename_column.rb
+- lib/shaf/generator/migration/type.rb
+- lib/shaf/generator/migration/types.rb
 - lib/shaf/generator/model.rb
 - lib/shaf/generator/policy.rb
 - lib/shaf/generator/scaffold.rb

metadata.gz.sig

@@ -1,2 +1 @@
-f��
8��^D�-X�@�t�w��v�fe&���x�x�x����̆��UR��©�dv\�j2q��0A	� ƻy*5�:��dC4�2�ʏfJ{��Ѡ����ɘo�Fo����Y�F1�23�ɦ��pZ�SĐ�XX����PԏZ�ӝ��Ƿ��p���5�W�lK�T�9
-�GF�b�~�G���?�w�|�B]���%=�_�^�F��(��4�g��RO�z ��SC�W�A���6��;��sᒶR��ӊ
+��_��1��YY=n�ʯ�\g{|��z�b5���)��؉_�]�%Y<?��oЁi��B�پ����Co�"}�I	n	���"�
����}<���kJ���ݒ��yy�r'۝2y��2���