sequent-sinatra 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4de24041294b04ecf9a92547e74e53a476ab37c
-  data.tar.gz: 0c1c4e5ce725830548554ea59e012f12aedea973
+  metadata.gz: ff3009b374b8b75cad6de45571b76487c92a691d
+  data.tar.gz: 8fa9e461c0c80a3f7b2610c8af6eeb915287165e
 SHA512:
-  metadata.gz: d6703e46cf329713855289c5e45873b3ac894d106ec28945b48801fba6f7085e5c3098572ff1f63f7864f8dc547b49448e97866fa3c5b39a37321017f7058f9e
-  data.tar.gz: 219ac73516d0956b3fde4d32f5cc2e695265ea244963a617c5a98801e73c648c608deb1f015a37130f3ff19c33ff09dd2bc41f49df79856279399832665f506d
+  metadata.gz: eecf5a4b6e328bad1282f225248d01b1a7c239cae5b55e6b917ae4feb824845b234283af491765cfec2bece2b85c63eca2d7611f61cb9cc0a875dcff05eae175
+  data.tar.gz: 4ce04e459bde7fe61d229495795e2595b135b67821dfda16a426fa0c4c50f71b57796419679f2faee1a03c226380103351002a28bd9f73fad4ade20fa6fc2951

data/lib/sequent-sinatra/app.rb

@@ -21,10 +21,16 @@ module Sequent
           app.helpers Sequent::Core::Helpers::UuidHelper
           app.helpers Sequent::Web::Sinatra::FormHelpers
           app.helpers Sequent::Web::Sinatra::SimpleCommandServiceHelpers
+          app.set :sequent_config_dir, app.root unless app.respond_to?(:sequent_config_dir)
 
           app.before do
-            require File.join(app.sequent_config_dir || app.root, 'initializers/sequent')
-            @command_service = Sequent::Core::CommandService.instance
+            config_file = File.join(app.sequent_config_dir, 'initializers/sequent')
+            if File.exist?("#{config_file}.rb") || File.exist?("#{config_file}")
+              require config_file
+            else
+              raise "Unable to initialize Sequent. Config file #{config_file} not found.\nInitialize Sequent correctly? First set the 'sequent_config_dir' or the 'root', then register Sequent::Web::Sinatra in your Sinatra application"
+            end
+            @command_service = Sequent.command_service
           end
 
         end

data/lib/sequent-sinatra/fieldset.rb

@@ -9,15 +9,25 @@ module Sequent
 
         attr_reader :path, :parent
 
+        def postfix
+          nil
+        end
+
         def initialize(parent, path, params, errors, options = {})
           raise "params are empty while creating new fieldset path #{path}" unless params
-          @values = params.has_key?(path) ? (params[path] || {}) : {}
+          @values = params[path] || {}
           @parent = parent
           @path = path.to_s.gsub(/\W+/, '')
           @errors = errors
           @options = options
         end
 
+        def nested_array(name)
+          (@values[name] || [{}]).each do |value|
+            yield FieldsetInArray.new(self, name, { name => value }, @errors, @options)
+          end
+        end
+
         def nested(name)
           yield Fieldset.new(self, name, @values, @errors, @options)
         end
@@ -29,9 +39,13 @@ module Sequent
         def path_for(field_name)
           css_id @path, field_name
         end
-
       end
 
+      class FieldsetInArray < Fieldset
+        def postfix
+          "[]"
+        end
+      end
     end
   end
 end

data/lib/sequent-sinatra/form_helpers.rb

@@ -4,21 +4,49 @@ require 'rack/csrf'
 module Sequent
   module Web
     module Sinatra
+      ##
+      # Various form helpers to help bind html forms to `Sequent::Core::Command`s
+      #
       module FormHelpers
+        ##
+        # Creates a form not bound to any Command
+        #
+        # Parameters
+        #   +action+ the action attribute of the <form> tag
+        #   +method+ the method attribute of the <form> tag.
+        #            :delete and :update will result in an extra hidden field _method to be set so sinatra will call the corresponding `delete '/' {}` or `update `/` {}` methods in your application.
+        #   +options+ options hash
+        #
         def html_form(action, method=:get, options={}, &block)
           html_form_for nil, action, method, options, &block
         end
 
+        ##
+        # Creates a for bound to an object that respond_to :as_params. This is typically a `Sequent::Core::Command` or a `Sequent::Core::ValueObject`.
+        #
+        # Parameters
+        #   +for_object+ The form backing object. This object must `include` Sequent::Core::Helpers::ParamSupport
+        #   +action+ the action attribute of the <form> tag
+        #   +method+ the method attribute of the <form> tag.
+        #            :delete and :update will result in an extra hidden field _method to be set so sinatra will call the corresponding `delete '/' {}` or `update `/` {}` methods in your application.
+        #   +options+ options hash
+        #
         def html_form_for(for_object, action, method=:get, options={}, &block)
           raise "Given object of class #{for_object.class} does not respond to :as_params. Are you including Sequent::Core::Helpers::ParamSupport?" if (for_object and !for_object.respond_to? :as_params)
           form = Form.new(self, for_object, action, method, options.merge(role: "form"))
           form.render(&block)
         end
 
+        ##
+        # Shorthand for Rack::Utils.escape_html(text)
+        #
         def h(text)
           Rack::Utils.escape_html(text)
         end
 
+        ##
+        # Shorthand for Rack::Csrf.csrf_tag(env)
+        #
         def csrf_tag
           raise "You must enable sessions to use FormHelpers" unless env
           Rack::Csrf.csrf_tag(env)

data/lib/sequent-sinatra/tag_helper.rb

@@ -1,7 +1,18 @@
 module Sequent
   module Web
     module Sinatra
+      ##
+      # Exposes various helper methods for creating form tags
+      #
       module TagHelper
+        ##
+        # creates a <input type=checkbox>
+        #
+        # Parameters
+        #   +field+ the name of the attribute within the current object.
+        #   +options+ Hash with optional attributes.
+        #               :value - the default checked value if the current object has none
+        #               :class - the css class
         def raw_checkbox(field, options={})
           id = css_id(@path, field)
           value = param_or_default(field, options[:value]) || id
@@ -13,14 +24,39 @@ module Sequent
                            )
         end
 
+        ##
+        # Creates a <input type=text>
+        #
+        # Parameters
+        #   +field+ the name of the attribute within the current object.
+        #   +options+ Hash with optional attributes.
+        #               :value - the default value if the current object has none
+        #               :class - the css class
         def raw_input(field, options={})
           raw_field(field, "text", options)
         end
 
+        ##
+        # Creates a <input type=password>
+        #
+        # Parameters
+        #   +field+ the name of the attribute within the current object.
+        #   +options+ Hash with optional attributes.
+        #               :value - the default value if the current object has none
+        #               :class - the css class
         def raw_password(field, options={})
           raw_field(field, "password", options)
         end
 
+        ##
+        # Creates a <textarea>
+        #
+        # Parameters
+        #   +field+ the name of the attribute within the current object.
+        #   +options+ Hash with optional attributes.
+        #               :value - the default value if the current object has none
+        #               :class - the css class
+        #               :rows - the number of rows of the textarea
         def raw_textarea(field, options={})
           value = param_or_default(field, options[:value])
 
@@ -30,10 +66,27 @@ module Sequent
                                                                ))
         end
 
+        ##
+        # Creates a <input type=hidden>
+        #
+        # Parameters
+        #   +field+ the name of the attribute within the current object.
+        #   +options+ Hash with optional attributes.
+        #               :value - the default value if the current object has none
+        #               :class - the css class
         def raw_hidden(field, options={})
           raw_field(field, "hidden", options)
         end
 
+        ##
+        # Creates a <select> with <option>
+        #
+        # Parameters
+        #   +field+ the name of the attribute within the current object.
+        #   +values+ an array of pairs (arrays) of [value, text_to_display]
+        #   +options+ Hash with optional attributes.
+        #               :value - the default value if the current object has none
+        #               :class - the css class
         def raw_select(field, values, options={})
           value = param_or_default(field, options[:value])
           content = ""
@@ -49,7 +102,7 @@ module Sequent
 
         def calculate_name(field)
           reverse_names = tree_in_names(field)
-          "#{reverse_names.first}#{reverse_names[1..-1].map { |n| "[#{n}]" }.join}"
+          "#{reverse_names.first}#{reverse_names[1..-1].map { |n| n == '[]' ? n : "[#{n}]" }.join}"
         end
 
         def full_path(field)
@@ -60,9 +113,10 @@ module Sequent
 
         def tree_in_names(field)
           if respond_to? :path
-            names = [field, path]
+            names = [field, postfix, path].compact
             parent = @parent
             while parent.is_a? Fieldset
+              names << parent.postfix if parent.postfix
               names << parent.path
               parent = parent.parent
             end
@@ -76,7 +130,6 @@ module Sequent
           @values.nil? ? default : @values.has_key?(field.to_s) ? @values[field.to_s] || default : default
         end
 
-
         def id_and_text_from_value(val)
           if val.is_a? Array
             [val[0], val[1]]

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SequentSinatra
-  VERSION='0.1.3'
+  VERSION='0.1.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequent-sinatra
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Lars Vonk
@@ -54,6 +54,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +152,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: Sequent is an event sourcing framework for Ruby. This gem allows Sequent
   to work with Sinatra-backed applications.
 email:
@@ -177,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Event sourcing framework for Ruby - Sinatra adapter