gourami 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6350a0c25f3ae177cd9f7f1679421265ca935c28
-  data.tar.gz: 67acb125ddd4c6641bf804cc3ceb1f7330b9f09a
+  metadata.gz: f7d45d0bcf1edbc6a81d3489bab6de5ccd4b0ea2
+  data.tar.gz: d04dff73bc07b0ad96aa619f11f710b6024b02e9
 SHA512:
-  metadata.gz: 941e297d65e2e2fda1c4636c3662360293f9bd2a0e9789446e397446ff176330fe4944fc16ce69867f531dd92a395b9a6e848d485e248670c1b1f60bb1f2c5dc
-  data.tar.gz: 913a0865ffd2357dab99423ac30ce46c737ebf74929404e245fb28c4fe92e76e1f9326d06e72767129d00b3067bb2de2cbf256787fd648e9257ce5f08c7db7a9
+  metadata.gz: 95bbf65d77ce12927bed88dbeab0ceacd4cd9d57654d163e94e827f18623ca39cfb029d5e67d9a56593809c9ebcf27220e273a7ddd70fd451a098c62d35b25b1
+  data.tar.gz: 10eacdc7e10de57f2daa4c600d331936984753ee5749445c4bbda6e867442a36e14bdb8eb509fa9bbc65f54fcc2baa78d410158ad8c40bac6288cdaff63ac5f2

data/README.md

@@ -20,7 +20,160 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### A Typical Gourami::Form will
+
+ - list a set of attributes
+ - validate user input
+ - perform an action
+
+```ruby
+class TypicalForm < Gourami::Form
+
+  attribute(:typical_attribute)
+
+  def validate
+    # Define Your validation rules here
+  end
+
+  def perform
+    # Perform your action rules here
+  end
+
+end
+```
+
+### Your Rails 5 ActionController for the New/Create action:
+
+```ruby
+def new
+  @form = CreateFishTank.new
+end
+
+def create
+  @form = CreateFishTank.new(fish_tank_params)
+
+  if @form.valid?
+    @form.perform
+    redirect_to @form.record
+  else
+    render "new"
+  end
+end
+```
+
+### Example of a form that Creates a record
+
+```ruby
+class CreateFishTank < Gourami::Form
+
+  record(:fish_tank)
+
+  attribute(:width, type: :integer)
+  attribute(:height, type: :integer)
+  attribute(:liters, type: :float)
+  attribute(:name, type: :string)
+  attribute(:filter_included, type: :boolean, default: false)
+
+  def validate
+    validate_presence(:width)
+    validate_range(:width, min: 50, max: 1000)
+
+    validate_presence(:height)
+    validate_range(:height, min: 50, max: 1000)
+
+    validate_presence(:liters)
+    validate_range(:liters, min: 5, max: 200)
+
+    validate_presence(:name)
+    validate_uniqueness(:name) do |name|
+      FishTank.where(name: name).empty?
+    end
+  end
+
+  def perform
+    self.fish_tank = FishTank.create(attributes)
+  end
+
+end
+```
+
+### Your Rails 5 ActionController for the Edit/Update action:
+
+```ruby
+def edit
+  fish_tank = FishTank.find(params[:id])
+  @form = UpdateFishTank.new_from_record(fish_tank)
+end
+
+def update
+  @form = UpdateFishTank.new(fish_tank_params)
+
+  if @form.valid?
+    @form.perform
+    redirect_to @form.record
+  else
+    render "edit"
+  end
+end
+```
+
+### Example of a form that Updates a record
+
+```ruby
+class UpdateFishTank < CreateFishTank
+
+  record(:fish_tank)
+
+  attribute(:width, type: :integer)
+  attribute(:height, type: :integer)
+  attribute(:liters, type: :float)
+  attribute(:name, type: :string)
+  attribute(:filter_included, type: :boolean, default: false)
+
+  def self.new_from_record(fish_tank)
+    new({ fish_tank: fish_tank }.merge(fish_tank.attributes))
+  end
+
+  def validate
+    validate_presence(:width)
+    validate_range(:width, min: 50, max: 1000)
+
+    validate_presence(:height)
+    validate_range(:height, min: 50, max: 1000)
+
+    validate_presence(:liters)
+    validate_range(:liters, min: 5, max: 200)
+
+    validate_presence(:name)
+    validate_uniqueness(:name) do |name|
+      FishTank.where(name: name).empty?
+    end
+  end
+
+  def perform
+    fish_tank.update(attributes)
+  end
+
+end
+```
+
+#### Or inherit instead of duplicating the attributes and validations
+
+```ruby
+class UpdateFishTank < CreateFishTank
+
+  # All attributes and validations inherited from CreateFishTank.
+
+  def self.new_from_record(fish_tank)
+    new({ fish_tank: fish_tank }.merge(fish_tank.attributes))
+  end
+
+  def perform
+    fish_tank.update(attributes)
+  end
+
+end
+```
 
 ## Development
 

data/gourami.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "pry", "~>0.10"
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

data/lib/gourami.rb

@@ -3,6 +3,7 @@ end
 
 require "gourami/attributes"
 require "gourami/coercer"
+require "gourami/extensions/resources"
 require "gourami/form"
 require "gourami/formatting_constants"
 require "gourami/required_attribute_error"

data/lib/gourami/validations.rb

@@ -5,6 +5,10 @@ module Gourami
 
     include Gourami::FormattingConstants
 
+    def validate
+      # Override to add custom validations
+    end
+
     # Validate and perform the form actions. If any errors come up during the
     #   validation or the #perform method, raise an exception with the errors.
     #
@@ -40,6 +44,19 @@ module Gourami
       !any_errors?
     end
 
+    # Replace the existing errors with the provided errors Hash.
+    #
+    # @param new_errors [Hash<Symbol, nil>, Array<Symbol, String>]
+    #
+    # @return [Hash<Symbol, nil>, Array<Symbol, String>]
+    def clear_and_set_errors(new_errors)
+      new_errors = new_errors.dup
+      errors.clear
+      errors.merge!(new_errors)
+
+      errors
+    end
+
     # Return true if there given attribute has any errors.
     def attribute_has_errors?(attribute_name)
       errors[attribute_name.to_sym].any?

data/lib/gourami/version.rb

@@ -1,3 +1,3 @@
 module Gourami
-  VERSION = "0.1.0"
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gourami
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - TSMMark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2017-05-08 00:00:00.000000000 Z
 dependencies:
+- !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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement