gourami 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a514a33e36dee0b4a2c39ef0320f4a8fa70ab24
-  data.tar.gz: 6acabd9872fd0346833fa7f50b527d1413a202f0
+  metadata.gz: f97edb63e52af97e6e63f41a74a824a04da00c21
+  data.tar.gz: 74bff6e2f3563c96205fc155f0b21db04df37169
 SHA512:
-  metadata.gz: 97e2db4cccf243740e2e1548673df9860a06aeb856516c77e9596bab2ff06c39c86c982266a5cbe24d33b6383d885cc1e4411d0fb934c7570628de2000edbfa7
-  data.tar.gz: 15cff403f9f9a2d2a7536278fa114fff0f503e8a13e539546f8ae049d978c76231c71fe7e60c5c65721b4761d2178bd6dd4340be5fbd23f3f472f635a6111f35
+  metadata.gz: f2ea15a122976499b06265949d859767170c66d7647bac35861a9bea9e8b95f2090da92bd8f6ee99f7677c59eb5ce47ab59d25e21922a2a6a2dd4698cd279d4e
+  data.tar.gz: a38f7c552c0939c3122171945e855e4edff4482206e8c4e1a5b82d9100a92d1de2ce462bffbee147804fdb763ecc042dd550f441cee909f26b54922e2cd3e78c

data/README.md

@@ -1,6 +1,6 @@
 # Gourami
 
-Keep your Routes, Controllers and Models thin.
+Keep your Routes, Controllers and Models thin with Plain Old Ruby Objects (PORO).
 
 ## Installation
 
@@ -22,9 +22,9 @@ Or install it yourself as:
 
 ### A Typical Gourami::Form will
 
- - list a set of attributes
- - validate user input
- - perform an action
+ - Define some attributes
+ - Validate user input
+ - Perform an action
 
 ```ruby
 class TypicalForm < Gourami::Form
@@ -32,7 +32,7 @@ class TypicalForm < Gourami::Form
   attribute(:typical_attribute)
 
   def validate
-    # Define Your validation rules here
+    # Define your validation rules here
   end
 
   def perform
@@ -67,7 +67,6 @@ end
 class CreateFishBowl < Gourami::Form
 
   record(:fish_bowl)
-
   attribute(:width, type: :integer)
   attribute(:height, type: :integer)
   attribute(:liters, type: :float)
@@ -120,10 +119,9 @@ end
 ### Example of a form that Updates a record
 
 ```ruby
-class UpdateFishBowl < CreateFishBowl
+class UpdateFishBowl < Gourami::Form
 
   record(:fish_bowl)
-
   attribute(:width, type: :integer)
   attribute(:height, type: :integer)
   attribute(:liters, type: :float)
@@ -131,7 +129,7 @@ class UpdateFishBowl < CreateFishBowl
   attribute(:filter_included, type: :boolean, default: false)
 
   def self.new_from_record(fish_bowl)
-    new({ fish_bowl: fish_bowl }.merge(fish_bowl.attributes))
+    new(fish_bowl.attributes.merge(fish_bowl: fish_bowl))
   end
 
   def validate
@@ -165,7 +163,7 @@ class UpdateFishBowl < CreateFishBowl
   # All attributes and validations inherited from CreateFishBowl.
 
   def self.new_from_record(fish_bowl)
-    new({ fish_bowl: fish_bowl }.merge(fish_bowl.attributes))
+    new(fish_bowl.attributes.merge(fish_bowl: fish_bowl))
   end
 
   def perform
@@ -175,6 +173,81 @@ class UpdateFishBowl < CreateFishBowl
 end
 ```
 
+#### Extensions / Plugins
+
+##### Gourami::Extensions::Changes
+
+Check to see if an attribute is being changed:
+
+```ruby
+class UpdateUserEmail < Gourami::Form
+
+  include Gourami::Extensions::Changes
+
+  record(:user)
+  attribute(:email, :type => :string, :watch_changes => true)
+
+  def perform
+    user.update(attributes)
+
+    do_something_like_send_confirmation_email(email) if changes?(:email)
+  end
+
+end
+```
+
+###### You can implement custom logic to determine if an attribute is changing
+
+This is the equivalent behavior when you set `:watch_changes => true`
+
+```ruby
+attribute(:email, :watch_changes => ->(new_value) { new_value != user.email })
+```
+
+Your logic to check for changes can be as sophisticated as you want.
+
+```ruby
+class UpdatePageAuthorizedUsers < Gourami::Form
+
+  include Gourami::Extensions::Changes
+
+  record(:page)
+  attribute(:authorized_users,
+    :type => :array,
+    :watch_changes => ->(new_value) { new_value.sort.uniq != page.authorized_users.sort.uniq })
+
+  def perform
+    page.update(attributes)
+
+    do_something_like_notify_authorization_libraries(authorized_users) if changes?(:authorized_users)
+  end
+
+end
+```
+
+You can also keep track of side effects due to changes by using `did_change`.
+
+```ruby
+class UpdatePageWidgets < Gourami::Form
+
+  include Gourami::Extensions::Changes
+
+  record(:page)
+  attribute(:widgets,
+    :type => :array,
+    :element_type => :string,
+    :watch_changes => ->(new_value) {
+      did_change(:pro_widget, new_value.include?("pro"))
+      new_value.sort.uniq != page.widgets.sort.uniq
+    })
+
+  def validate
+    append_error(:widgets, :unauthorized) if changes?(:pro_widget) && !current_user_has_pro_account?
+  end
+
+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.

data/lib/gourami.rb

@@ -1,12 +1,18 @@
 module Gourami
 end
 
+require "gourami/error"
+require "gourami/configuration_error"
+require "gourami/not_watching_changes_error"
+require "gourami/required_attribute_error"
+require "gourami/validation_error"
+require "gourami/watch_changes_error"
+
 require "gourami/attributes"
 require "gourami/coercer"
+require "gourami/extensions/changes"
 require "gourami/extensions/resources"
 require "gourami/form"
 require "gourami/formatting_constants"
-require "gourami/required_attribute_error"
-require "gourami/validation_error"
 require "gourami/validations"
 require "gourami/version"

data/lib/gourami/attributes.rb

@@ -23,39 +23,42 @@ module Gourami
         options = options.dup
         options[:default] = default_block if block_given?
 
-        unless options[:skip_reader]
-          define_method(:"#{name}") do
-            value = instance_variable_get(:"@#{name}")
-            default = options[:default]
-
-            if value.nil? && default
-              default.respond_to?(:call) ? instance_exec(&default) : default
-            else
-              value
+        mixin = Module.new do |mixin|
+          unless options[:skip_reader]
+            mixin.send(:define_method, :"#{name}") do
+              value = instance_variable_get(:"@#{name}")
+              default = options[:default]
+
+              if value.nil? && default
+                default.respond_to?(:call) ? instance_exec(&default) : default
+              else
+                value
+              end
             end
           end
-        end
 
-        # Define external setter.
-        define_method(:"#{name}=") do |value|
-          provided_attributes_names[name.to_s] = options
-          send(:"_#{name}=", value)
-        end
+          # Define external setter.
+          mixin.send(:define_method, :"#{name}=") do |value|
+            provided_attributes_names[name.to_s] = options
+            send(:"_#{name}=", value)
+          end
 
-        # Define internal setter.
-        define_method(:"_#{name}=") do |value|
-          value = setter_filter(name, value, options)
-          instance_variable_set(:"@#{name}", value)
-        end
-        private :"_#{name}="
+          # Define internal setter.
+          mixin.send(:define_method, :"_#{name}=") do |value|
+            instance_variable_set(:"@#{name}", setter_filter(name, value, options))
+          end
+          mixin.send(:private, :"_#{name}=")
 
-        case options[:type]
-        when :boolean
-          define_method(:"#{name}?") do
-            !!send(name)
+          case options[:type]
+          when :boolean
+            mixin.send(:define_method, :"#{name}?") do
+              !!send(name)
+            end
           end
         end
 
+        include(mixin)
+
         attributes[name] = options
       end
 
@@ -71,7 +74,7 @@ module Gourami
         define_method(:record) do
           send(name)
         end
-        attribute(name, options.merge(:skip => true))
+        attribute(name, options.merge(:skip => true, :record => true))
       end
 
       # Retrieve the list of attributes of the form.

data/lib/gourami/configuration_error.rb

@@ -0,0 +1,4 @@
+module Gourami
+  class ConfigurationError < Gourami::Error
+  end
+end

data/lib/gourami/error.rb

@@ -0,0 +1,4 @@
+module Gourami
+  class Error < StandardError
+  end
+end

data/lib/gourami/extensions/changes.rb

@@ -0,0 +1,69 @@
+module Gourami
+  module Extensions
+    module Changes
+      WATCH_CHANGES_VALID_RETURN_VALUES = [true, false].freeze
+
+      module ClassMethods
+        def attribute(name, options = {}, &default_block)
+          super.tap do
+            watch_changes = options.fetch(:watch_changes, false)
+
+            if watch_changes
+              mixin = Module.new do |mixin|
+                mixin.send(:define_method, :"_#{name}=") do |value|
+                  super(value).tap do
+                    new_value = instance_variable_get(:"@#{name}")
+                    attribute_did_change = if watch_changes.respond_to?(:call)
+                      instance_exec(new_value, &watch_changes)
+                    elsif !defined?(record)
+                      raise ConfigurationError, "Default `watch_changes` behavior not available without a `record`. Try `attribute(:#{name}, :watch_changes => ->(new_value) { new_value != custom_check_logic )`"
+                    elsif record.nil?
+                      !new_value.nil?
+                    else
+                      record.send(name) != new_value
+                    end
+
+                    unless WATCH_CHANGES_VALID_RETURN_VALUES.include?(attribute_did_change)
+                      raise WatchChangesError, "`watch_changes` block for `#{name.inspect}` must return one of #{WATCH_CHANGES_VALID_RETURN_VALUES.inspect}."
+                    end
+
+                    did_change(name, attribute_did_change)
+                  end
+                end
+                mixin.send(:private, :"_#{name}=")
+              end
+              include(mixin)
+            end
+          end
+        end
+      end
+
+      def self.included(klass)
+        klass.send(:extend, ClassMethods)
+      end
+
+      def changes?(attribute_name)
+        attribute_name_sym = attribute_name.to_sym
+        changed_attributes.fetch(attribute_name_sym) do
+          options = self.class.attributes.fetch(attribute_name_sym, {})
+          watch_changes = options.fetch(:watch_changes, false)
+
+          return false if watch_changes
+
+          raise NotWatchingChangesError, "`#{attribute_name}` is not being watched for changes. " \
+            "Try `attribute(:#{attribute_name}, :watch_changes => true)`"
+        end
+      end
+
+      def did_change(attribute_name, changed = true)
+        changed_attributes[attribute_name.to_sym] = !!changed
+      end
+
+      private
+
+      def changed_attributes
+        @changed_attributes ||= {}
+      end
+    end
+  end
+end

data/lib/gourami/not_watching_changes_error.rb

@@ -0,0 +1,4 @@
+module Gourami
+  class NotWatchingChangesError < Gourami::Error
+  end
+end

data/lib/gourami/required_attribute_error.rb

@@ -1,4 +1,4 @@
 module Gourami
-  class RequiredAttributeError < StandardError
+  class RequiredAttributeError < Gourami::Error
   end
 end

data/lib/gourami/validation_error.rb

@@ -1,5 +1,5 @@
 module Gourami
-  class ValidationError < StandardError
+  class ValidationError < Gourami::Error
 
     def self.stringify_errors(errors)
       [].tap do |array|

data/lib/gourami/version.rb

@@ -1,3 +1,3 @@
 module Gourami
-  VERSION = "0.1.2".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/gourami/watch_changes_error.rb

@@ -0,0 +1,4 @@
+module Gourami
+  class WatchChangesError < Gourami::Error
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gourami
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - TSMMark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -87,13 +87,18 @@ files:
 - lib/gourami.rb
 - lib/gourami/attributes.rb
 - lib/gourami/coercer.rb
+- lib/gourami/configuration_error.rb
+- lib/gourami/error.rb
+- lib/gourami/extensions/changes.rb
 - lib/gourami/extensions/resources.rb
 - lib/gourami/form.rb
 - lib/gourami/formatting_constants.rb
+- lib/gourami/not_watching_changes_error.rb
 - lib/gourami/required_attribute_error.rb
 - lib/gourami/validation_error.rb
 - lib/gourami/validations.rb
 - lib/gourami/version.rb
+- lib/gourami/watch_changes_error.rb
 homepage: http://github.com/Vydia/gourami
 licenses:
 - MIT
@@ -114,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Keep your Routes, Controllers and Models thin.