gourami 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aeeb89759c11dd7f9559824ccfd42bc6ab7755aa2d60f11b8a38e5b0db08902
-  data.tar.gz: 80c1968c495c2cff9277b4bd51c0340bd8381874dc864d53dab711091f61443a
+  metadata.gz: f4786ed7265bcf16aca2b9fb9e4a695e84b6d7e31ebe5264870e8674f71a1115
+  data.tar.gz: dcd57424cf0af46cda99949e77051c70beb4204c4b85f82c8d4300ed229fb09b
 SHA512:
-  metadata.gz: 97af9a59317e79d499c95b7b05f31a5089e9f56c7b7970818c22b36482de075f646f212b12e41ad4b53d9be1e967c34b08b34e55c46a90e033151f46416208dc
-  data.tar.gz: 48979f3194878e519431c3a46deb3da5eea9dc624731483f89e8006370d84c30027445b4ac6b31f0ca91b1d669539ad79edf988c51a2d8b2f56f7877b1659cdd
+  metadata.gz: 6a1811ded432ac060c4461dc790e2cb08f9b7779157f6533cb8d32c9e189f1a716c0824dcc6ca8764d8bf21a2c8bbd67d1822860d11fb5f3d37979a75a03451a
+  data.tar.gz: 7158387f0e394fe67f165df9a8e63aa2b8889d13e26e867d74048a68c9655cded3a181e731bddc4d73d6d087e60a5b83deea899ce7a5a5cbbee5311344a35a33

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: ci
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Build Gem
+      run: gem build gourami.gemspec
+    - name: Run tests
+      run: bundle exec rake test

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/README.md

@@ -1,5 +1,7 @@
 # Gourami
 
+![Github Actions CI](https://github.com/Vydia/gourami/workflows/ci/badge.svg)
+
 Keep your Routes, Controllers and Models thin with Plain Old Ruby Objects (PORO).
 
 ## Installation
@@ -12,7 +14,7 @@ gem 'gourami'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -20,10 +22,10 @@ Or install it yourself as:
 
 ## Usage
 
-### A Typical Gourami::Form will
+### A Typical `Gourami::Form` will
 
- - Define some attributes
- - Validate user input
+ - Define attributes (inputs & outputs)
+ - Validate input
  - Perform an action
 
 ```ruby
@@ -173,6 +175,56 @@ class UpdateFishBowl < CreateFishBowl
 end
 ```
 
+#### Configure default attribute options
+
+The following examples will result in all `:string` attributes getting the options `:strip` and `:upcase` set to `true`.
+
+Set global defaults:
+
+```ruby
+Gourami::Form.set_default_attribute_options(:string, upcase: true)
+
+# Make sure to define CreateFishBowl and other forms AFTER setting default options.
+class CreateFishBowl < Gourami::Form
+  attribute(:name, type: :string)
+end
+
+form = CreateFishBowl.new(name: "Snake Gyllenhaal")
+form.name # => "SNAKE GYLLENHAAL"
+```
+
+Instead of global defaults, you can also apply defaults to certain form classes.
+
+Just as `attributes` are inherited by subclasses, so are `default_attribute_options`.
+
+Set local defaults:
+
+```ruby
+class ScreamingForm < Gourami::Form
+  set_default_attribute_options(:string, upcase: true)
+end
+
+class CreateScreamingFish < ScreamingForm
+  attribute(:name, type: :string)
+end
+
+class UpdateScreamingFish < CreateScreamingFish; end
+
+create_form = CreateScreamingFish.new(name: "Snake Gyllenhaal")
+create_form.name # => "SNAKE GYLLENHAAL"
+
+update_form = UpdateScreamingFish.new(name: "Snake Gyllenhaal")
+update_form.name # => "SNAKE GYLLENHAAL"
+
+# Other Gourami::Forms are unaffected
+class RegularForm < Gourami::Form
+  attribute(:name, type: :string)
+end
+
+regular_form = RegularForm.new(name: "Snake Gyllenhaal")
+regular_form.name # => "Snake Gyllenhaal"
+```
+
 #### Extensions / Plugins
 
 ##### Gourami::Extensions::Changes
@@ -250,7 +302,7 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests, or `rake test:watch` to automatically rerun the tests when you make code changes. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 

data/lib/gourami/attributes.rb

@@ -9,6 +9,7 @@ module Gourami
       def inherited(klass)
         super(klass)
         klass.instance_variable_set(:@attributes, attributes.dup)
+        klass.instance_variable_set(:@default_attribute_options, default_attribute_options.dup)
       end
 
       # Define an attribute for the form.
@@ -25,15 +26,17 @@ module Gourami
         options = options.dup
         options[:default] = default_block if block_given?
 
+        options_with_defaults = merge_default_attribute_options(options)
+
         mixin = Module.new do |mixin|
-          unless options[:skip_reader]
-            if !base.attributes.key?(name) && base.instance_methods.include?(name) && !options[:override_reader]
+          unless options_with_defaults[:skip_reader]
+            if !base.attributes.key?(name) && base.instance_methods.include?(name) && !options_with_defaults[:override_reader]
               raise AttributeNameConflictError, "#{name} is already a method. To use the existing method, use `:skip_reader => true` option. To override the existing method, use `:override_reader => true` option."
             end
 
             mixin.send(:define_method, :"#{name}") do
               value = instance_variable_get(:"@#{name}")
-              default = options[:default]
+              default = options_with_defaults[:default]
 
               if value.nil? && default
                 default.respond_to?(:call) ? instance_exec(&default) : default
@@ -51,7 +54,7 @@ module Gourami
 
           # Define internal setter.
           mixin.send(:define_method, :"_#{name}=") do |value|
-            instance_variable_set(:"@#{name}", setter_filter(name, value, options))
+            instance_variable_set(:"@#{name}", setter_filter(name, value, self.class.merge_default_attribute_options(options)))
           end
           mixin.send(:private, :"_#{name}=")
 
@@ -76,11 +79,11 @@ module Gourami
       # @option options [Class]
       #   The Class of the type of this attribute. Can be any of String, Integer,
       #   Float, Array, Hash or :boolean.
-      def record(name, options = {})
+      def record(name, options = {}, &block)
         define_method(:record) do
           send(name)
         end
-        attribute(name, options.merge(:skip => true, :record => true))
+        attribute(name, options.merge(:skip => true, :record => true), &block)
       end
 
       # Retrieve the list of attributes of the form.
@@ -90,6 +93,24 @@ module Gourami
       def attributes
         @attributes ||= {}
       end
+
+      # Useful if you want, for example, all type: :string attributes to use
+      # strip: true to remove whitespace padding.
+      def set_default_attribute_options(attr_type, options)
+        default_attribute_options[attr_type] = options
+      end
+
+      def default_attribute_options
+        @default_attribute_options ||= {}
+      end
+
+      def merge_default_attribute_options(options)
+        if options[:type]
+          default_attribute_options.fetch(options[:type], {}).merge(options)
+        else
+          options
+        end
+      end
     end
 
     # Extend ClassMethods into including class.

data/lib/gourami/coercer.rb

@@ -33,6 +33,9 @@ module Gourami
       end
 
       value = value.to_s.dup.force_encoding(Encoding::UTF_8)
+
+      # TODO: Instead of providing unconfigurable defaults like this, use
+      # set_default_attribute_options at the gem level or consumer level.
       value.strip! if options.fetch(:strip, true)
       value.upcase! if options.fetch(:upcase, false)
 
@@ -84,6 +87,9 @@ module Gourami
         element_type_options = {}
       end
 
+      element_type_options[:type] = element_type
+      element_type_options = self.class.merge_default_attribute_options(element_type_options) if self.class.respond_to?(:merge_default_attribute_options)
+
       coercer_method_name = :"coerce_#{element_type}"
 
       value.map do |array_element|
@@ -149,6 +155,9 @@ module Gourami
           value_type_options = {}
         end
 
+        value_type_options[:type] = value_type
+        value_type_options = self.class.merge_default_attribute_options(value_type_options) if self.class.respond_to?(:merge_default_attribute_options)
+
         value = send(:"coerce_#{value_type}", value, value_type_options) if value_type
 
         coerced_hash[key] = value

data/lib/gourami/version.rb

@@ -1,3 +1,3 @@
 module Gourami
-  VERSION = "1.3.0".freeze
+  VERSION = "1.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gourami
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - TSMMark
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,8 +88,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -118,7 +119,7 @@ homepage: http://github.com/Vydia/gourami
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: Keep your Routes, Controllers and Models thin.
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.1.8
-before_install: gem install bundler -v 1.13.5