gourami 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6350a0c25f3ae177cd9f7f1679421265ca935c28
+  data.tar.gz: 67acb125ddd4c6641bf804cc3ceb1f7330b9f09a
+SHA512:
+  metadata.gz: 941e297d65e2e2fda1c4636c3662360293f9bd2a0e9789446e397446ff176330fe4944fc16ce69867f531dd92a395b9a6e848d485e248670c1b1f60bb1f2c5dc
+  data.tar.gz: 913a0865ffd2357dab99423ac30ce46c737ebf74929404e245fb28c4fe92e76e1f9326d06e72767129d00b3067bb2de2cbf256787fd648e9257ce5f08c7db7a9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mark.allen@vydia.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TSMMark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Gourami
+
+Keep your Routes, Controllers and Models thin.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'gourami'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gourami
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TSMMark/gourami. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :spec => :test
+task :default => :test

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gourami"
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/gourami.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gourami/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gourami"
+  spec.version       = Gourami::VERSION
+  spec.authors       = ["TSMMark"]
+  spec.email         = ["9thousand@gmail.com"]
+
+  spec.summary       = %q{Keep your Routes, Controllers and Models thin.}
+  spec.description   = %q{Create Plain Old Ruby Objects that take attributes, validate them, and perform an action.}
+  spec.homepage      = "http://github.com/TSMMark/gourami"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/gourami.rb

@@ -0,0 +1,11 @@
+module Gourami
+end
+
+require "gourami/attributes"
+require "gourami/coercer"
+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

@@ -0,0 +1,180 @@
+module Gourami
+  module Attributes
+
+    module ClassMethods
+      # Copy parent attributes to inheriting class.
+      #
+      # @param klass [Class]
+      def inherited(klass)
+        super(klass)
+        klass.instance_variable_set(:@attributes, attributes.dup)
+      end
+
+      # Define an attribute for the form.
+      #
+      # @param name
+      #   The Symbol attribute name.
+      # @option options
+      #   The type of this attribute. Can be any of :string, :integer,
+      #   :float, :array, :hash or :boolean.
+      # @block default_block
+      #   If provided, the block will be applied to options as the :default
+      def attribute(name, options = {}, &default_block)
+        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
+            end
+          end
+        end
+
+        # Define external setter.
+        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}="
+
+        case options[:type]
+        when :boolean
+          define_method(:"#{name}?") do
+            !!send(name)
+          end
+        end
+
+        attributes[name] = options
+      end
+
+      # Define the main record of this form (optional).
+      #   Record may be called with form_instance.record
+      #
+      # @param name
+      #   The Symbol attribute name.
+      # @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 = {})
+        define_method(:record) do
+          send(name)
+        end
+        attribute(name, options.merge(:skip => true))
+      end
+
+      # Retrieve the list of attributes of the form.
+      #
+      # @return [Hash]
+      #   The class attributes hash.
+      def attributes
+        @attributes ||= {}
+      end
+    end
+
+    # Extend ClassMethods into including class.
+    #
+    # @param klass [Class]
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+    end
+
+    # Initialize a new Gourami::Form form.
+    #
+    # @param attrs [Hash]
+    #   The attributes values to use for the new instance.
+    def initialize(attrs = {})
+      set_attributes(attrs)
+    end
+
+    # Set the attributes belonging to the form.
+    # Overrides ALL existing attributes,
+    #   including ones not provided in the `attrs` argument.
+    #
+    # @param attrs [Hash<[String, Symbol], Object>]
+    def set_attributes(attrs)
+      return unless attrs.kind_of?(Hash)
+
+      attrs = attrs.map { |k, v| [k.to_s, v] }.to_h
+
+      self.class.attributes.each do |name, opts = {}|
+        name = name.to_s
+
+        if attrs.key?(name)
+          value = attrs[name]
+          provided_attributes_names[name] = opts
+        end
+
+        if value.nil? && opts[:required] && !opts[:default]
+          # TODO: Consider raising this during validate or perform instead.
+          raise RequiredAttributeError, "#{name.inspect} is a required attribute of #{self.class.to_s}"
+        end
+
+        send(:"_#{name}=", value)
+      end
+    end
+
+    # Offer descendants the opportunity to modify attribute values as they are set.
+    #
+    # @param attribute_name [Symbol] name of the attribute
+    # @param value [*] the value as it is passed into the setter
+    # @param options [Hash] attribute options
+    #
+    # @return [*]
+    def setter_filter(attribute_name, value, options)
+      value
+    end
+
+    # Get the all attributes with its values of the current form except the attributes labeled with skip.
+    #
+    # @return [Hash<Symbol, Object>]
+    def attributes
+      unskipped_attributes = self.class.attributes.reject { |_, opts| opts[:skip] }
+      attributes_hash_from_attributes_options(unskipped_attributes)
+    end
+
+    # Get the all attributes with its values of the current form.
+    #
+    # @return [Hash<Symbol, Object>]
+    def all_attributes
+      attributes_hash_from_attributes_options(self.class.attributes)
+    end
+
+    def provided_attributes
+      unskipped_attributes = self.class.attributes.reject { |_, opts| opts[:skip] }
+      provided_attributes = unskipped_attributes.select { |name, _| attribute_provided?(name) }
+      attributes_hash_from_attributes_options(provided_attributes)
+    end
+
+    def provided_attributes_names
+      @provided_attributes_names ||= {}
+    end
+
+    def attribute_provided?(attribute_name)
+      provided_attributes_names.key?(attribute_name.to_s)
+    end
+
+    # Get the all attributes given a hash of attributes with options.
+    #
+    # @param attributes_options [Hash<Symbol, Hash>] attributes with options
+    #
+    # @return [Hash<Symbol, Object>]
+    def attributes_hash_from_attributes_options(attributes_options)
+      attributes_options.each_with_object({}) do |(name, _), attrs|
+        attrs[name] = send(name)
+      end
+    end
+
+  end
+end

data/lib/gourami/coercer.rb

@@ -0,0 +1,211 @@
+module Gourami
+  module Coercer
+
+    # When it is being set, coerce the value of the attribute
+    # according to the :type option.
+    #
+    # @param attribute_name [Symbol] name of the attribute
+    # @param value [*] the value as it is passed into the setter
+    # @param options [Hash] attribute options
+    #
+    # @return [*]
+    def setter_filter(attribute_name, value, options)
+      type = options[:type]
+      coercer_method_name = :"coerce_#{type}"
+      if type
+        value = send(coercer_method_name, value, options)
+      end
+
+      super(attribute_name, value, options)
+    end
+
+    # Coerce the value into a String.
+    #
+    # @param value [Object]
+    # @option allow_nil [Boolean] (true)
+    # @option upcase [Boolean] (false)
+    # @option strip [Boolean] (false)
+    #
+    # @return [String, nil]
+    def coerce_string(value, options = {})
+      return nil if value.nil? && options.fetch(:allow_nil, true)
+
+      value = value.to_s.dup.force_encoding(Encoding::UTF_8)
+      value.strip! if options[:strip]
+      value.upcase! if options[:upcase]
+
+      value
+    end
+
+    # Corce the value into true or false.
+    #
+    # @param value [Object]
+    # @option allow_nil [Boolean] (false)
+    #
+    # @return [Boolean, nil]
+    def coerce_boolean(value, options = {})
+      return nil if options[:allow_nil] && (value.nil? || value == "")
+      return false if value.to_s.strip == "false"
+      !!value && !coerce_string(value).strip.empty?
+    end
+
+    # Coerce the value into an Array.
+    #
+    # @param value [Object]
+    #   The value to be coerced.
+    # @option element_type [Symbol, Hash] (nil)
+    #   The type of the value to coerce each element of the array, if nil
+    #   no coercion is performed.
+    #   If a Hash is given, it is passed as options to the coercer.
+    #
+    # TODO docs for the rest of the options
+    #
+    # @return [Array]
+    #   The coerced Array.
+    def coerce_array(value, options = {})
+      element_type = options[:element_type]
+      value = value.values if value.kind_of?(Hash)
+
+      if options[:split_by] && value.kind_of?(String)
+        value = value.split(options[:split_by]).map(&:strip)
+      end
+
+      if value.kind_of?(Array)
+        if element_type
+          if element_type.kind_of?(Hash)
+            element_type_options = element_type
+            element_type = element_type[:type]
+          else
+            element_type_options = {}
+          end
+
+          coercer_method_name = :"coerce_#{element_type}"
+          value.map do |array_element|
+            send(coercer_method_name, array_element, element_type_options)
+          end
+        else
+          value
+        end
+      else
+        []
+      end
+    end
+
+    # Coerce the value into a Float.
+    #
+    # @param value [Object]
+    #
+    # @return [Float, nil]
+    def coerce_float(value, options = {})
+      Float(value) rescue nil
+    end
+
+    # Coerce the value into an international phone String.
+    #
+    # @param value [Object]
+    #   The value to be coerced.
+    #
+    # @return [String, nil]
+    def coerce_phone(value, options = {})
+      value ? coerce_string(value).upcase.gsub(/[^+0-9A-Z]/,"") : nil
+    end
+
+    # Coerce the value into a Hash.
+    #
+    # @param value [Object]
+    #   The value to be coerced.
+    # @option options :key_type [Symbol, Callable] (nil)
+    #   The type of the hash keys to coerce, no coersion if value is nil.
+    # @option options :value_type [Symbol, Callable] (nil)
+    #   The type of the hash values to coerce, no coersion if value is nil.
+    #
+    # @return [Hash]
+    #   The coerced Hash.
+    def coerce_hash(value, options = {})
+      hash_key_type = options[:key_type]
+      hash_value_type = options[:value_type]
+      if value.kind_of?(Hash) || value.kind_of?(Sequel::Postgres::JSONHash)
+        value.each_with_object({}) do |(key, value), coerced_hash|
+          key_type = hash_key_type.respond_to?(:call) ? hash_key_type.call(key, value) : hash_key_type
+          key = send("coerce_#{key_type}", key) if key_type
+
+          value_type = hash_value_type.respond_to?(:call) ? hash_value_type.call(key, value) : hash_value_type
+          value = send("coerce_#{value_type}", value) if value_type
+          coerced_hash[key] = value
+        end
+      else
+        {}
+      end
+    end
+
+    # Coerce the value into an Integer.
+    #
+    # @param value [Object]
+    #   The value to be coerced.
+    #
+    # @return [Integer, nil]
+    #   An Integer if the value can be coerced or nil otherwise.
+    def coerce_integer(value, options = {})
+      value = value.to_s
+      if value.match(/\A0|[1-9]\d*\z/)
+        value.to_i
+      else
+        nil
+      end
+    end
+
+    # Coerce the value into a Date.
+    #
+    # @param value [Object]
+    #   The value to be coerced.
+    #
+    # @return [Date, nil]
+    #   A Date if the value can be coerced or nil otherwise.
+    def coerce_date(value, options = {})
+      value = coerce_string(value, options)
+      return nil if value.nil?
+      begin
+        Date.strptime(value, "%Y-%m-%d")
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Coerce the value into a Time.
+    #
+    # @param value [Object]
+    #   The value to be coerced.
+    #
+    # @return [Time, nil]
+    #   A Time if the value can be coerced or nil otherwise.
+    def coerce_time(value, options = {})
+      value = coerce_string(value, options)
+      return nil if !value || value.empty?
+
+      begin
+        Time.parse(value).utc
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Coerce the value into a File. For the value to be successfully accepted as,
+    # it should be a hash containing the :filename (String) and :tempfile
+    # (File).
+    #
+    # @param value [Object]
+    #
+    # @return [Hash, nil]
+    #   The hash will contain the file String :filename and the File :tempfile,
+    #   or nil otherwise.
+    def coerce_file(value, options = {})
+      if value.kind_of?(Hash) && !value[:filename].to_s.empty?
+        tempfile = value[:tempfile]
+        if tempfile.kind_of?(File) || tempfile.kind_of?(Tempfile)
+          value
+        end
+      end
+    end
+
+  end
+end

data/lib/gourami/extensions/resources.rb

@@ -0,0 +1,96 @@
+module Gourami
+  module Extensions
+    module Resources
+
+      # Return a deeply nested Hash which allows you to identify errors by resource.
+      #
+      # @return [Hash<Symbol>]
+      #
+      # @example
+      #   resource_errors
+      #   # => {
+      #   #   :social_broadcasts => {
+      #   #     :"facebook_page-41" => {
+      #   #       :trim_start_time => [:is_invalid, :is_too_short],
+      #   #       :trim_end_time => [:is_invalid]
+      #   #     },
+      #   #     :"youtube_account-42" => {
+      #   #       :title => [:is_too_short]
+      #   #     }
+      #   #   },
+      #   #   :another_resource => {
+      #   #     :"other_resource_id-12" => {
+      #   #       :something => [:is_too_long]
+      #   #     }
+      #   #   }
+      #   # }
+      #
+      #   resource_errors[:social_broadcasts]
+      #   # => {
+      #   #   :"facebook_page-41" => {
+      #   #     :trim_start_time => [:is_invalid, :is_too_short],
+      #   #     :trim_end_time => [:is_invalid]
+      #   #   },
+      #   #   :"youtube_account-42" => {
+      #   #     :title => [:is_too_short]
+      #   #   }
+      #   # }
+      #
+      #   resource_errors[:social_broadcasts][:"facebook_page-41"]
+      #   # => {
+      #   #   :trim_start_time => [:is_invalid, :is_too_short],
+      #   #   :trim_end_time => [:is_invalid]
+      #   # }
+      #
+      #   resource_errors[:social_broadcasts][:"facebook_page-41"][:trim_start_time]
+      #   # => [:is_invalid, :is_too_short]
+      def resource_errors
+        @resource_errors ||= Hash.new do |resource_errors, resource_name|
+          resource_errors[resource_name] = Hash.new do |resource_uids, resource_uid|
+            resource_uids[resource_uid] = Hash.new do |attributes, attribute_name|
+              attributes[attribute_name] = []
+            end
+          end
+        end
+      end
+
+      # TODO: YARD
+      def resource_has_errors?(resource_namespace, resource_uid)
+        resource_errors[resource_namespace, resource_uid.to_s].values.map(&:flatten).any?
+      end
+
+      # TODO: YARD
+      def resource_attribute_has_errors?(resource_namespace, resource_uid, attribute_name)
+        resource_errors[resource_namespace][resource_uid.to_s][attribute_name].any?
+      end
+
+      # Append an error to the given attribute for a resource.
+      # TODO: consider coercing attribute_name `.to_s` too.
+      #
+      # @param resource_namespace [Symbol]
+      # @param resource_uid [String]
+      # @param attribute_name [Symbol]
+      # @param error [Symbol, String]
+      #   The error identifier.
+      def append_resource_error(resource_namespace, resource_uid, attribute_name, error)
+        resource_errors[resource_namespace][resource_uid.to_s][attribute_name] << error
+      end
+
+      # Determine if current form instance is valid by running the validations
+      #   specified on #validate.
+      #
+      # @return [Boolean]
+      def any_errors?
+        super || any_resource_errors?
+      end
+
+      # Return true if any resources by any uids have any errors.
+      #
+      # @return [Boolean]
+      def any_resource_errors?
+        resource_errors.values.flat_map(&:values).map(&:values).flatten.any?
+      end
+
+    end
+  end
+end

data/lib/gourami/form.rb

@@ -0,0 +1,92 @@
+require_relative "./attributes"
+require_relative "./validations"
+require_relative "./coercer"
+
+module Gourami
+  # Base Form for doing actions based on the attributes specified.
+  # This class has to be inherited by different forms, each performing a
+  # different action. If needed, #validate method can be overridden if
+  # necessary.
+  #
+  # @example
+  #
+  #   class LogIn < Gourami::Form
+  #
+  #     attribute(:username, :type => :string)
+  #     attribute(:password, :type => :string)
+  #
+  #     def validate
+  #       unless valid_login?
+  #         append_error(:username, :invalid_credentials)
+  #       end
+  #     end
+  #
+  #     def perform
+  #       User.create(attributes)
+  #     end
+  #
+  #     private
+  #
+  #     def valid_login?
+  #       user = User.first(:username => username)
+  #       user && check_password_secure(user.password, password)
+  #     end
+  #
+  #   end
+  #
+  # @example
+  #
+  #   class UpdateUser < Gourami::Form
+  #
+  #     VALID_TYPES = %w[buyer seller]
+  #
+  #     record(:user, :skip => true)
+  #     attribute(:username, :type => :string)
+  #     attribute(:first_name, :type => :string)
+  #     attribute(:percentage, :type => :integer)
+  #     attribute(:type, :type => :string)
+  #
+  #     def validate
+  #       validate_presence(:username)
+  #       validate_length(:username, :min => 2, :max => 64)
+  #
+  #       validate_presence(:first_name)
+  #
+  #       validate_presence(:percantage)
+  #       validate_range(:percentage, :min => 0, :max => 100)
+  #
+  #       validate_presence(:type)
+  #       validate_inclusion(:type, VALID_TYPES)
+  #     end
+  #
+  #     def perform
+  #       user.update(attributes)
+  #     end
+  #
+  #   end
+  #
+  #   # Usage of the new form class:
+  #
+  #   form = UpdateUser.new({
+  #     :user => User.first,
+  #     :username => "WeijieWorld",
+  #     :first_name => "Weijie",
+  #     :percentage => "100",
+  #     :type => "buyer"
+  #   })
+  #
+  #   if form.valid?
+  #     form.perform
+  #     # Do something else
+  #   else
+  #     # Do something else
+  #   end
+  #
+  class Form
+
+    include Gourami::Attributes
+    include Gourami::Validations
+    include Gourami::Coercer
+
+  end
+end

data/lib/gourami/formatting_constants.rb

@@ -0,0 +1,13 @@
+module Gourami
+  module FormattingConstants
+
+    EMAIL_FORMAT = (/\A
+      ([0-9a-zA-Z\.][-\w\+\.]*)@
+      ([0-9a-zA-Z_][-\w]*[0-9a-zA-Z]*\.)+[a-zA-Z]{2,9}\z/x).freeze
+
+    ISRC_FORMAT = (/\A[a-zA-Z]{2}[a-zA-Z0-9]{5}[0-9]{5}\z/).freeze
+
+    HEX_COLOR_FORMAT = (/^#([A-F0-9]{3}|[A-F0-9]{6})$/i).freeze
+
+  end
+end

data/lib/gourami/required_attribute_error.rb

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

data/lib/gourami/validation_error.rb

@@ -0,0 +1,35 @@
+module Gourami
+  class ValidationError < StandardError
+
+    def self.stringify_errors(errors)
+      [].tap do |array|
+        errors.each do |field, error|
+          array.push("#{field}: #{error}")
+        end
+      end
+    end
+
+    # !@attribute [r] errors
+    #   @return [Hash<Symbol, Array>]
+    attr_reader :errors
+
+    # Initialize the Gourami::ValidationError.
+    #
+    # @param errors [Hash<Symbol, Array>]
+    def initialize(errors)
+      @errors = errors
+      super(message)
+    end
+
+    def message
+      @message ||= "Validation failed with errors: #{stringify_errors.join("\n")}"
+    end
+
+    private
+
+    def stringify_errors
+      ValidationError.stringify_errors(errors)
+    end
+
+  end
+end

data/lib/gourami/validations.rb

@@ -0,0 +1,214 @@
+require_relative "./formatting_constants"
+
+module Gourami
+  module Validations
+
+    include Gourami::FormattingConstants
+
+    # Validate and perform the form actions. If any errors come up during the
+    #   validation or the #perform method, raise an exception with the errors.
+    #
+    # @raise [Gourami::ValidationError]
+    def perform!
+      if valid?
+        returned = perform
+      end
+
+      if any_errors?
+        raise ValidationError.new(errors)
+      end
+
+      returned
+    end
+
+    # Get the current form errors Hash.
+    #
+    # @return [Hash<Symbol, nil>, Array<Symbol, String>]
+    #   The errors Hash, having the Symbol attribute names as keys and an
+    #   array of errors (Symbols) as the value.
+    def errors
+      @errors ||= Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    # Determine if current form instance is valid by running the validations
+    #   specified on #validate.
+    #
+    # @return [Boolean]
+    def valid?
+      errors.clear
+      validate
+      !any_errors?
+    end
+
+    # Return true if there given attribute has any errors.
+    def attribute_has_errors?(attribute_name)
+      errors[attribute_name.to_sym].any?
+    end
+
+    # Return true if there are any errors.
+    def any_errors?
+      errors.reject{ |k,v| v.empty? }.any?
+    end
+
+    # Append an error to the given attribute.
+    #
+    # @param attribute_name [Symbol, nil] nil for base
+    # @param error [Symbol, String]
+    #   The error identifier.
+    def append_error(attribute_name, error)
+      errors[attribute_name] << error
+    end
+
+    # Validate the presence of the attribute value. If the value is nil or
+    #   false append the :cant_be_empty error to the attribute.
+    #
+    # @param attribute_name [Symbol]
+    def validate_presence(attribute_name, message = nil)
+      value = send(attribute_name)
+      if !value || value.to_s.strip.empty?
+        append_error(attribute_name, message || :cant_be_empty)
+      end
+    end
+
+    # Validate the uniqueness of the attribute value. The uniqueness is
+    #   determined by the block given. If the value is not unique, append the
+    #   :is_duplicated error to the attribute.
+    #
+    # @param attribute_name [Symbol]
+    # @param block [Proc]
+    #   A block to determine if a given value is unique or not. It receives
+    #   the value and returns true if the value is unique.
+    def validate_uniqueness(attribute_name, message = nil, &block)
+      value = attributes[attribute_name]
+      unless block.call(value)
+        append_error(attribute_name, message || :is_duplicated)
+      end
+    end
+
+    # Validate the email format. If the value does not match the email format,
+    #   append the :is_invalid error to the attribute.
+    #
+    # @param attribute_name [Symbol]
+    def validate_email_format(attribute_name, message = nil)
+      validate_format(attribute_name, EMAIL_FORMAT, message)
+    end
+
+    def validate_isrc_format(attribute_name, message = nil)
+      validate_format(attribute_name, ISRC_FORMAT, message)
+    end
+
+    def validate_color_format(attribute_name, message = nil)
+      validate_format(attribute_name, HEX_COLOR_FORMAT, message)
+    end
+
+    # Validate the format of the attribute value. If the value does not match
+    #   the regexp given, append :is_invalid error to the attribute.
+    #
+    # @param attribute_name [Symbol]
+    # @param format [Regexp]
+    def validate_format(attribute_name, format, message = nil)
+      value = attributes[attribute_name]
+      if value && !(format =~ value)
+        append_error(attribute_name, message || :is_invalid)
+      end
+    end
+
+    # Validate the length of a String, Array or any other form attribute which
+    #   responds to #size. If the value is too short, append the :too_short
+    #   error to the attribute. If the value is too long append the :too_long
+    #   error to the attribute.
+    #
+    # @param attribute_name [Symbol]
+    # @option options [Integer, nil] :min (nil)
+    # @option options [Integer, nil] :max (nil)
+    def validate_length(attribute_name, options = {})
+      # TODO: Support :unless_already_invalid => true in more validators.
+      return if options.fetch(:unless_already_invalid, false) && attribute_has_errors?(attribute_name)
+
+      min = options.fetch(:min, nil)
+      max = options.fetch(:max, nil)
+      value = attributes[attribute_name]
+
+      return if options[:allow_blank] && value.blank?
+
+      if value
+        length = value.size
+        if min && length < min
+          append_error(attribute_name, options.fetch(:min_message, nil) || :is_too_short)
+        end
+        if max && length > max
+          append_error(attribute_name, options.fetch(:max_message, nil) || :is_too_long)
+        end
+      end
+    end
+
+    # Validate the value of the given attribute is included in the list. If
+    #   the value is not included in the list, append the :not_listed error to
+    #   the attribute.
+    #
+    # @param attribute_name [Symbol]
+    # @param list [Array]
+    def validate_inclusion(attribute_name, list, message = nil)
+      value = attributes[attribute_name]
+      if value && !list.include?(value)
+        append_error(attribute_name, message || :isnt_listed)
+      end
+    end
+
+    # Validate the presence of each object in attribute name within list. If the object
+    #   is not included in the list, append the :not_listed error to the attribute.
+    def validate_inclusion_of_each(attribute_name, list, message = nil)
+      value = send(attribute_name)
+      value && value.each do |obj|
+        unless list.include?(obj)
+          append_error(attribute_name, message || "#{obj} isn't listed")
+          break
+        end
+      end
+    end
+
+    # Validate the value of the given attribute is not empty.
+    # Appends :cant_be_empty error.
+    #
+    # @param attribute_name [Symbol]
+    def validate_any(attribute_name, message = nil)
+      value = attributes[attribute_name]
+      if value && value.empty?
+        append_error(attribute_name, message || :cant_be_empty)
+      end
+    end
+
+    # Validate the type of the file sent if included in the list. If it's not,
+    #   append an :invalid_file error to the attribute.
+    #
+    # @param attribute_name [Symbol]
+    # @param filetypes [Array<String>]
+    def validate_filetype(attribute_name, filetypes, message = nil)
+      value = send(attribute_name)
+      if value && !filetypes.include?(value[:type].to_s.split("/").first)
+        append_error(attribute_name, message || :is_invalid)
+      end
+    end
+
+    # Validate the range in which the attribute can be. If the value is less
+    #   than the min a :less_than_min error will be appended. If the value is
+    #   greater than the max a :greater_than_max error will be appended.
+    #
+    # @param attribute_name [Symbol]
+    # @option options [Integer] :min (nil)
+    #   The minimum value the attribute can take, if nil, no validation is made.
+    # @option options [Integer] :max (nil)
+    #   The maximum value the attribute can take, if nil, no validation is made.
+    def validate_range(attribute_name, options = {})
+      value = send(attribute_name)
+
+      return unless value
+
+      min = options.fetch(:min, nil)
+      max = options.fetch(:max, nil)
+      append_error(attribute_name, options.fetch(:min_message, nil) || :less_than_min) if min && value < min
+      append_error(attribute_name, options.fetch(:max_message, nil) || :greater_than_max) if max && value > max
+    end
+
+  end
+end

data/lib/gourami/version.rb

@@ -0,0 +1,3 @@
+module Gourami
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: gourami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TSMMark
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Create Plain Old Ruby Objects that take attributes, validate them, and
+  perform an action.
+email:
+- 9thousand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gourami.gemspec
+- lib/gourami.rb
+- lib/gourami/attributes.rb
+- lib/gourami/coercer.rb
+- lib/gourami/extensions/resources.rb
+- lib/gourami/form.rb
+- lib/gourami/formatting_constants.rb
+- lib/gourami/required_attribute_error.rb
+- lib/gourami/validation_error.rb
+- lib/gourami/validations.rb
+- lib/gourami/version.rb
+homepage: http://github.com/TSMMark/gourami
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Keep your Routes, Controllers and Models thin.
+test_files: []