shaf 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9af4fa12d1002e4c4fcfe233c640e0efff4d779d8bed3b884dec7da3d2d7eef
-  data.tar.gz: 7748f68242de611ece5e8f556686e924f627f6346f5c90e56b1b15d3bbd4ce04
+  metadata.gz: 5fa1ac79ab7ea9af45c8d160116ab1aee7ed964254927fe9045664930405e2c6
+  data.tar.gz: bf9dc19468e7b25d5e0c94c8484558f89bd6ec84e47d4d00211c3d57029909fc
 SHA512:
-  metadata.gz: 0dc246772c0a1c5d74d738a4618173e83819a67d9cb88e17b37c7894ffbc27ce977f1acfb2edcf3cf88bc12fc34f202e9e974d930976ff997c26f2cceaa1b3cb
-  data.tar.gz: 4fb0286154086c4859b109f79fd70836d3dd44d777688964b235cb32a2ad1afc897f8ae3df9544616934d9b63363c2714e6d11d81d4d0c327238b46aae3db50d
+  metadata.gz: d383a3b23dd5675fc3683a8b2c76407bcc9cf25ff17eb699b4cbd75898d053fdd1d1a2b8fb522eedf4fe8c7330a726dfc126d39508ce7c50c0a211b0ba6e8a86
+  data.tar.gz: f03870ee03fdc20f04541c9bff9cde8a1d2fa1ef3b1a0a0a52b0a20724cee752a5abe3b6f5eb5ec330125c010f8bc1f85acd9e18eaa3f97884ff33d66fe087ea

data/lib/shaf/formable/builder.rb

@@ -0,0 +1,61 @@
+require 'shaf/formable/form'
+
+module Shaf
+  module Formable
+    class Builder
+      DELEGATES = %i[title name action method type fields].freeze
+
+      attr_reader :forms
+
+      def initialize(&block)
+        @forms = []
+        @instance_accessors = []
+
+        exec_with_form(block)
+      end
+
+      def instance_accessor_for?(form)
+        @instance_accessors.include? form
+      end
+
+      private
+
+      attr_reader :form
+
+      def exec_with_form(block, action: nil)
+        current, @form = form, new_form
+        form.action = action if action
+        instance_exec(&block)
+      ensure
+        @form = current
+      end
+
+      def new_form
+        (form&.dup || Formable::Form.new).tap { |f| @forms << f }
+      end
+
+      def instance_accessor
+        @instance_accessors << form
+      end
+
+      DELEGATES.each do |name|
+        define_method(name) do |arg|
+          form.send("#{name}=".to_sym, arg)
+        end
+      end
+
+      def field(name, opts = {})
+        form.add_field(name, opts)
+      end
+
+      def method_missing(method, *args, &block)
+        return super unless args.empty? && block
+        exec_with_form(block, action: method)
+      end
+
+      def respond_to_missing?(*)
+        true
+      end
+    end
+  end
+end

data/lib/shaf/formable/field.rb

@@ -0,0 +1,60 @@
+require 'shaf/immutable_attr'
+
+module Shaf
+  module Formable
+    class Field
+      extend Shaf::ImmutableAttr
+
+      immutable_reader :name, :type, :value, :label, :required
+
+      HTML_TYPE_MAPPINGS = {
+        'string' => 'text',
+        'boolean' => 'checkbox',
+      }.freeze
+
+      def initialize(name, params = {})
+        @name = name
+        @type = params[:type]
+        @label = params[:label]
+        @has_value = params.key? :value
+        @value = params[:value]
+        @required = params[:required] || false
+      end
+
+      def has_value?
+        @has_value
+      end
+
+      def to_html
+        [
+          '<div class="form--input-group">',
+          label_element,
+          input_element,
+          '</div>'
+        ].compact.join("\n")
+      end
+
+      private
+
+      def label_element
+        str = (label || name || "").to_s
+        %Q(<label for="#{name}" class="form--label">#{str}</label>)
+      end
+
+      def input_element
+        _value = value ? %Q(value="#{value.to_s}") : nil
+        _required = required ? "required" : nil
+        attributes = [
+          %Q(type="#{HTML_TYPE_MAPPINGS[type.to_s]}"),
+          'class="form--input"',
+          %Q(id="#{name.to_s}"),
+          %Q(name="#{name.to_s}"),
+        ]
+        attributes << %Q(value="#{value.to_s}") if value
+        attributes << "required" if required
+
+        "<input #{attributes.join(" ")}>"
+      end
+    end
+  end
+end

data/lib/shaf/formable/form.rb

@@ -0,0 +1,98 @@
+require 'shaf/formable/field'
+require 'shaf/immutable_attr'
+
+module Shaf
+  module Formable
+    class Form
+      extend Shaf::ImmutableAttr
+
+      DEFAULT_TYPE = 'application/json'.freeze
+
+      attr_accessor :resource
+      immutable_accessor :title, :name, :href, :type, :self_link
+      immutable_reader :fields, :action
+
+      def initialize(params = {})
+        @title = params[:title]
+        @action = params[:action]
+        @name = params[:name] || name_from(@action)
+        @method = params[:method] ||= http_method_from(@action)
+        @type = params[:type] || DEFAULT_TYPE
+        @fields = (params[:fields] || {}).map do |name, args|
+          Field.new(name, args)
+        end
+      end
+
+      def method=(http_method)
+        @method = http_method.to_s.upcase
+      end
+
+      def method
+        return unless @method
+        @method.to_s.upcase
+      end
+
+      def fields=(fields)
+        @fields = fields.map { |name, args| Field.new(name, args) }
+      end
+
+      def action=(action)
+        @action = action
+        @name ||= name_from action
+        @method ||= http_method_from action
+      end
+
+      def add_field(name, opts)
+        @fields << Field.new(name, opts)
+      end
+
+      def dup
+        super.tap do |obj|
+          obj.instance_variable_set(:@fields, @fields.map(&:dup))
+        end
+      end
+
+      def clone
+        dup.tap { |obj| obj.freeze if frozen? }
+      end
+
+      def to_html
+        form_element do
+          [
+            hidden_method_element,
+            fields.map(&:to_html).join("\n"),
+            submit_element
+          ].compact.join("\n")
+        end
+      end
+
+      private
+
+      def name_from(action)
+        :"#{action}-form" if action
+      end
+
+      def http_method_from(action)
+        return unless action
+        action&.to_sym == :edit ? 'PUT' : 'POST'
+      end
+
+      def form_element
+        [
+          %Q(<form class="form" method=#{method == 'GET' ? 'GET' : 'POST'}#{href ? %Q( action="#{href.to_s}") : ''}>),
+          block_given? ? yield : nil,
+          '</form>'
+        ].compact.join("\n")
+      end
+
+      def hidden_method_element
+        return if %w[GET POST].include? method
+        %Q(<input type="hidden" name="_method" value="#{method}">)
+      end
+
+      def submit_element
+        %Q(<div class="form--input-group"><input type="submit" class="button" value="Submit"</div>)
+      end
+    end
+  end
+end

data/lib/shaf/formable.rb

@@ -1,204 +1,20 @@
+require 'shaf/formable/builder'
+
 module Shaf
   module Formable
-    class Field
-      attr_reader :name, :type, :value, :label, :required
-
-      HTML_TYPE_MAPPINGS = {
-        'string' => 'text',
-        'boolean' => 'checkbox',
-      }.freeze
-
-      def initialize(name, params = {})
-        @name = name
-        @type = params[:type]
-        @label = params[:label]
-        @has_value = params.key? :value
-        @value = params[:value]
-        @required = params[:required] || false
-      end
-
-      def has_value?
-        @has_value
-      end
-
-      def to_html
-        [
-          '<div class="form--input-group">',
-          label_element,
-          input_element,
-          '</div>'
-        ].compact.join("\n")
-      end
-      
-      private
-
-      def label_element
-        str = (label || name || "").to_s
-        %Q(<label for="#{name}" class="form--label">#{str}</label>)
-      end
-
-      def input_element
-        _value = value ? %Q(value="#{value.to_s}") : nil
-        _required = required ? "required" : nil
-        attributes = [
-          %Q(type="#{HTML_TYPE_MAPPINGS[type.to_s]}"),
-          'class="form--input"',
-          %Q(id="#{name.to_s}"),
-          %Q(name="#{name.to_s}"),
-        ]
-        attributes << %Q(value="#{value.to_s}") if value
-        attributes << "required" if required
-
-        "<input #{attributes.join(" ")}>"
-      end
-    end
+    def form(&block)
+      builder = Formable::Builder.new(&block)
+      builder.forms.each do |f|
+        next unless f.action
+        getter = "#{f.action}_form"
 
-    class Form
-
-      DEFAULT_TYPE = 'application/json'
-
-      attr_accessor :resource, :name, :title, :href, :type, :self_link
-      attr_reader :fields
-
-      def initialize(params = {})
-        @name = params[:name]
-        @title = params[:title]
-        @method = params[:method] || 'POST'
-        @type = params[:type] || DEFAULT_TYPE
-        @fields = (params[:fields] || {}).map { |name, args| Field.new(name, args) }
-      end
+        define_singleton_method(getter) { f }
+        next unless builder.instance_accessor_for? f
 
-      def method=(m)
-        @method = m.to_s.upcase
-      end
-
-      def method
-        @method.to_s.upcase
-      end
-
-      def fields=(fields)
-        @fields = fields.map { |name, args| Field.new(name, args) }
-      end
-
-      def add_field(name, opts)
-        @fields << Field.new(name, opts)
-      end
-
-      def to_html
-        form_element do
-          [
-            hidden_method_element,
-            fields.map { |f| f.to_html }.join("\n"),
-            submit_element,
-          ].compact.join("\n")
+        define_method(getter) do
+          f.dup.tap { |fm| fm.resource = self }
         end
       end
-
-      private
-
-      def form_element
-        [
-          %Q(<form class="form" method=#{method == 'GET' ? 'GET' : 'POST'}#{href ? %Q( action="#{href.to_s}") : ''}>),
-          block_given? ? yield : nil,
-          "</form>",
-        ].compact.join("\n")
-      end
-
-      def hidden_method_element
-        return if ['GET', 'POST'].include?(method)
-        %Q(<input type="hidden" name="_method" value="#{method}">)
-      end
-
-      def submit_element
-        %Q(<div class="form--input-group"><input type="submit" class="button" value="Submit"</div>)
-      end
-    end
-
-    class Builder
-      def self.call(block)
-        [
-          new(block, create: true).call,
-          new(block, edit: true).call
-        ]
-      end
-
-      attr_reader :block
-
-      def initialize(block, create: false, edit: false)
-        @block = block
-        @create = create
-        @edit = edit
-        @form = nil
-        @default_method = @create ? :post : :put
-      end
-
-      def call
-        instance_exec(&block)
-        @form
-      end
-
-      def form
-        @form ||= Form.new(method: @default_method)
-      end
-
-      def name(name)
-        form.name = name
-      end
-
-      def title(title)
-        form.title = title
-      end
-
-      def method(method)
-        form.method = method
-      end
-
-      def type(type)
-        form.type = type
-      end
-
-      def fields(fields)
-        form.fields = fields
-      end
-
-      def field(name, opts = {})
-        form.add_field(name, opts)
-      end
-
-      def create(&b)
-        return unless @create
-        call_nested_block(b)
-      end
-
-      def edit(&b)
-        return unless @edit
-        call_nested_block(b)
-      end
-
-      def call_nested_block(b)
-        old, @block = @block, b
-        call
-      ensure
-        @block = old
-      end
-    end
-
-    module ClassMethods
-      attr_reader :create_form, :edit_form
-
-      def form(&block)
-        @create_form, @edit_form = Builder.(block)
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    def edit_form
-      self.class.edit_form.tap do |form|
-        form&.resource = self
-      end
     end
   end
 end

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

@@ -99,14 +99,13 @@ module Shaf
         end
 
         def regexp_db_format_string(type)
-          COMPLEX_DB_TYPES.each do |complex_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)
-            if errors.nil? || errors.empty?
-              return complex_type[:strings].map { |s| replace_backreferences(match, s) }
-            end
-            raise "Failed to process '#{type}': #{errors.join(', ')}"
+            raise "Failed to process '#{type}': #{errors&.join(', ')}" unless Array(errors).empty?
+
+            break complex_type[:strings].map { |s| replace_backreferences(match, s) }
           end
         end
 
@@ -118,13 +117,13 @@ module Shaf
         end
 
         def render
-          <<~EOS
+          <<~RUBY
             Sequel.migration do
               change do
                 #{@changes.flatten.join("\n    ")}
               end
             end
-          EOS
+          RUBY
         end
       end
 

data/lib/shaf/generator/migration.rb

@@ -6,7 +6,7 @@ module Shaf
         extend RegistrableFactory
       end
 
-      class Generator < Generator::Base
+      class Generator < Shaf::Generator::Base
         identifier :migration
         usage { Factory.usage }
 

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

@@ -1,5 +1,5 @@
 class <%= class_name %> < Sequel::Model
-  include Shaf::Formable
+  extend Shaf::Formable
 
 <% if form_fields.any? %>
   form do
@@ -11,6 +11,7 @@ class <%= class_name %> < Sequel::Model
     end
 
     edit do
+      instance_accessor
       title 'Update <%= class_name %>'
       name  'update-<%= model_name %>'
     end

data/lib/shaf/helpers/paginate.rb

@@ -8,7 +8,7 @@ module Shaf
 
     def paginate!(collection, per_page = PAGINATION_PER_PAGE)
       unless collection.respond_to? :paginate
-        log.warning "Trying to paginate a collection that doesn't " \
+        log.warn "Trying to paginate a collection that doesn't " \
                     "support pagination: #{collection}"
         return
       end

data/lib/shaf/immutable_attr.rb

@@ -0,0 +1,51 @@
+module Shaf
+  module ImmutableAttr
+    NON_DUPABLE_CLASSES = [
+      NilClass,
+      TrueClass,
+      FalseClass,
+      Symbol
+    ]
+
+    def self.dup(obj)
+      return obj unless obj.respond_to? :dup
+      return obj if NON_DUPABLE_CLASSES.include? obj.class
+      obj.dup
+    end
+
+    def immutable_reader(*methods)
+      methods.each do |method|
+        define_method(method) do
+          value = instance_variable_get(:"@#{method}")
+          ImmutableAttr.dup(value)
+        end
+      end
+    end
+
+    def immutable_writer(*methods)
+      methods.each do |method|
+        define_method(:"#{method}=") do |value|
+          instance_variable_set(
+            :"@#{method}",
+            ImmutableAttr.dup(value)
+          )
+        end
+      end
+    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
+    end
+  end
+end

data/lib/shaf/spec/payload_utils.rb

@@ -55,6 +55,8 @@ module Shaf
                     field[:name].size
                   when 'string'
                     "value for #{field[:name]}"
+                  when 'boolean'
+                    true
                   else
                     "type not supported"
                   end

data/lib/shaf/upgrade/manifest.rb

@@ -5,17 +5,21 @@ module Shaf
     class Manifest
       attr_reader :target_version, :files
 
-      def initialize(target_version:, patches: nil, add: nil, drop: nil)
-        @target_version = target_version
+      def initialize(**params)
+        @target_version = params[:target_version]
         @files = {}
-        @files[:patch] = build_patterns(patches)
-        @files[:add] = add || {}
-        @files[:drop] = (drop || []).map { |d| Regexp.new(d) }
+        @files[:patch] = build_patterns(params[:patches])
+        @files[:add] = params[:add] || {}
+        @files[:drop] = (params[:drop] || []).map { |d| Regexp.new(d) }
+        @files[:regexp] = build_patterns(params[:substitutes])
       end
 
       def patch_for(file)
-        first_match = files[:patch].find { |_, pattern| file =~ pattern }
-        (first_match || []).first
+        files[:patch].select { |_, pattern| file =~ pattern }.keys
+      end
+
+      def regexp_for(file)
+        files[:regexp].select { |_, pattern| file =~ pattern }.keys
       end
 
       def drop?(file)
@@ -25,7 +29,8 @@ module Shaf
       def stats
         "Add: #{files[:add].size}, " \
           "Del: #{files[:drop].size}, " \
-          "Patch: #{files[:patch].size}"
+          "Patch: #{files[:patch].size}, " \
+          "Regexp: #{files[:regexp].size}"
       end
 
       private
@@ -50,3 +55,5 @@ end
 #   8ece24b8c440675bd3d188155909431c: api/policies/base_policy.rb
 # drop:
 # - api/policies/base_policy.rb
+# substitutes:
+#   d3b07384d113edec49eaa6238ad5ff00: api/models/.*.rb

data/lib/shaf/upgrade/package.rb

@@ -4,6 +4,8 @@ require 'set'
 require 'digest'
 require 'open3'
 require 'fileutils'
+require 'tempfile'
+require 'yaml'
 
 module Shaf
   module Upgrade
@@ -15,7 +17,6 @@ module Shaf
       class VersionConflictError < UpgradeError; end
       class ManifestNotFoundError < UpgradeError; end
       class MissingFileError < UpgradeError; end
-      class FileNotInManifestError < UpgradeError; end
       class BadChecksumError < UpgradeError; end
 
       UPGRADE_FILES_PATH = File.join(Utils.gem_root, 'upgrades').freeze
@@ -78,6 +79,7 @@ module Shaf
         apply_patches(dir)
         apply_additions
         apply_drops(dir)
+        apply_substitutes(dir)
       end
 
       def to_s
@@ -111,7 +113,8 @@ module Shaf
           target_version: hash["target_version"],
           patches: hash["patches"],
           add: hash["add"],
-          drop: hash["drop"]
+          drop: hash["drop"],
+          substitutes: hash["substitutes"]
         )
       end
 
@@ -124,12 +127,9 @@ module Shaf
         manifest_patches = @manifest.files[:patch].keys.to_set
         raise MissingFileError if from_file < manifest_patches
 
-
         to_add = @manifest.files[:add].keys.to_set
         raise MissingFileError if from_file < to_add
 
-        raise FileNotInManifestError if (manifest_patches + to_add) < from_file
-
         @files.each do |md5, content|
           raise BadChecksumError unless Digest::MD5.hexdigest(content) == md5
         end
@@ -144,10 +144,10 @@ module Shaf
 
       def apply_patches(dir = nil)
         files_in(dir).all? do |file|
-          name = @manifest.patch_for(file) # returns nil when file
-          next true unless name            # shouldn't be patched
-          patch = @files[name]
-          apply_patch(file, patch)
+          @manifest.patch_for(file).all? do |name|
+            patch = @files[name]
+            apply_patch(file, patch)
+          end
         end
       end
 
@@ -177,6 +177,32 @@ module Shaf
           File.unlink(file) if @manifest.drop?(file)
         end
       end
+
+      def apply_substitutes(dir = nil)
+        files_in(dir).all? do |file|
+          @manifest.regexp_for(file).all? do |name|
+            params = symbolize_keys(YAML.safe_load(@files[name]))
+            apply_substitute(file, params)
+          end
+        end
+      end
+
+      def apply_substitute(file, params)
+        pattern = params[:pattern] or return
+        replacement = params[:replace] or return
+        tmp = Tempfile.open do |new_file|
+          File.readlines(file).each do |line|
+            new_file << line.sub(Regexp.new(pattern), replacement)
+          end
+          new_file
+        end
+        FileUtils.mv(tmp.path, file)
+      end
+
+      # Refactor this when support for ruby < 2.5 is dropped
+      def symbolize_keys(hash)
+        hash.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      end
     end
   end
 end

data/lib/shaf/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2018-10-21 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -137,6 +137,9 @@ files:
 - lib/shaf/extensions/resource_uris.rb
 - lib/shaf/extensions/symbolic_routes.rb
 - lib/shaf/formable.rb
+- lib/shaf/formable/builder.rb
+- lib/shaf/formable/field.rb
+- lib/shaf/formable/form.rb
 - lib/shaf/generator.rb
 - lib/shaf/generator/base.rb
 - lib/shaf/generator/controller.rb
@@ -164,6 +167,7 @@ files:
 - lib/shaf/helpers/json_html.rb
 - lib/shaf/helpers/paginate.rb
 - lib/shaf/helpers/payload.rb
+- lib/shaf/immutable_attr.rb
 - lib/shaf/middleware.rb
 - lib/shaf/middleware/request_id.rb
 - lib/shaf/rake.rb
@@ -222,6 +226,7 @@ files:
 - templates/spec/spec_helper.rb
 - upgrades/0.4.0.tar.gz
 - upgrades/0.5.0.tar.gz
+- upgrades/0.6.0.tar.gz
 homepage: https://github.com/sammyhenningsson/shaf
 licenses:
 - MIT