path_utilities 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dde60fc83340b54e2036fab5afeb5bcb6444fa1
+  data.tar.gz: 662aa813cfa1ce402655c6b228dea9450e7d3d32
+SHA512:
+  metadata.gz: 549fe786c774302e5a8a44300bf77c085627e75414f244000f04c6e6377e3ee552c9bd4c1099e5e04cb41f33f0eacc64b753d33b421655eba3e3a5b3bd2144a7
+  data.tar.gz: 2a4fe2a99e642919a1f5679a60659e8d539ee2ffbbb08ee4dc91324a002288d019151fb721682696cd71433ab0e0e42bba319f712dbc4117356edec19d542bf5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.3
+  - 2.2.0
+services: mongodb
+before_install:
+  - gem update bundler
+script:
+  - bundle exec rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in path_utilities.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 European Travel S.L.
+
+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,84 @@
+# PathUtilities
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/path_utilities`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'path_utilities'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install path_utilities
+
+## Usage
+
+Given a model like this
+
+```ruby
+class User
+  include Mongoid::Document
+
+  field :login
+  field :password
+  field :name
+end
+```
+
+Add a form for validating it
+
+```ruby
+class FormUser
+  include PathUtilities::Form
+
+  properties [:login, :name, :password], :user
+
+  validates_uniqueness_of :login
+  validates_presence_of :name, :password
+end
+```
+
+Perform user validation
+
+```ruby
+class MyController < ApplicationController
+  before_action :build, on: [:new, :create]
+
+  def create
+    if @form.validate(params[:user])
+      @form.save
+      redirect_to sign_in_path
+    else
+      render :new
+    end
+  end
+
+  def build
+    @form = FormUser.new(user: User.new)
+  end
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/path_utilities/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "path_utilities"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/path_utilities/form/uniqueness_validator/mongoid.rb

@@ -0,0 +1,48 @@
+require 'mongoid/validatable/uniqueness'
+
+module PathUtilities
+  module Form
+    module UniquenessValidator
+      class Mongoid < ::Mongoid::Validatable::UniquenessValidator
+        def initialize(options)
+          @klass = options[:model] if options[:model]
+          super
+        end
+
+        def validate_each(record, attribute, value)
+          # UniquenessValidator can't be used outside of Mongoid::Document instances, here
+          # we return the exact same error, unless the 'model' option is given.
+          #
+          if !options[:model] && !record.class.ancestors.include?(Mongoid::Document)
+            fail ArgumentError, "Unknown validator: 'UniquenessValidator'"
+
+          # If we're inside an ActiveRecord class, and `model` isn't set, use the
+          # default behaviour of the validator.
+          #
+          elsif ! options[:model]
+            super
+
+          # Custom validator options. The validator can be called in any class, as
+          # long as it includes `ActiveModel::Validations`. You can tell the validator
+          # which Mongoid::Document based class to check against, using the `model`
+          # option. Also, if you are using a different attribute name, you can set the
+          # correct one for the ActiveRecord class using the `attribute` option.
+          #
+          else
+            record_org, attribute_org = record, attribute
+
+            attribute = options[:attribute].to_sym if options[:attribute]
+            record = options[:model].new(attribute => value)
+
+            super
+
+            if record.errors.any?
+              record_org.errors.add(attribute_org, :taken,
+                options.except(:case_sensitive, :scope).merge(value: value))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/path_utilities/form/uniqueness_validator.rb

@@ -0,0 +1,8 @@
+module PathUtilities
+  module Form
+    module UniquenessValidator
+      autoload :Mongoid,
+               'path_utilities/form/uniqueness_validator/mongoid'
+    end
+  end
+end

data/lib/path_utilities/form.rb

@@ -0,0 +1,140 @@
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'active_model/naming'
+require 'active_model/conversion'
+require 'active_model/validations'
+
+module PathUtilities
+  module Form
+    extend ActiveSupport::Concern
+
+    autoload :UniquenessValidator, 'path_utilities/form/uniqueness_validator'
+
+    included do
+      include Virtus.model
+      extend ActiveModel::Naming
+      include ActiveModel::Conversion
+      include ActiveModel::Validations
+
+      attr_reader :models_mapping
+
+      def initialize(models_mapping = {})
+        @models_mapping = models_mapping
+        validate_mapping!
+      end
+
+      def validate_mapping!
+        self.class.models.each do |model|
+          next if models_mapping.keys.include?(model)
+          fail "#{model.to_s.camelize} not mapped on initialization"
+        end
+      end
+
+      def validate(params)
+        self.class.fields.keys.each do |field|
+          send("#{field}=", params[field])
+        end
+
+        valid?
+      end
+
+      def persisted?
+        false
+      end
+
+      def save
+        if valid?
+          sync
+          persist!
+          true
+        else
+          false
+        end
+      end
+
+      def sync
+        self.class.fields.keys.each do |field|
+          form_field_value = send(field)
+          instance_model_for(field).send("#{field}=", form_field_value)
+        end
+      end
+
+      def instance_model_for(field)
+        model = self.class.fields[field].options[:klass].name.underscore.to_sym
+        models_mapping[model]
+      end
+
+      def persist!
+        models_mapping.values.all?(&:save)
+      end
+      private :persist!
+    end
+
+    class_methods do
+      def properties(attributes, model)
+        @attributes ||= {}
+        add_model(model)
+        attributes.each do |att|
+          already_define_attribute_warn(att, model) do
+            attribute att, String
+          end
+
+          @attributes[att] = model.to_s.camelize
+                                  .safe_constantize.fields[att.to_s]
+        end
+      end
+
+      def fields
+        @attributes
+      end
+
+      def already_define_attribute_warn(attr, new_model)
+        if @attributes[attr].nil?
+          yield
+        else
+          Rails.logger.warn "#{attr} param already defined " \
+                            "for #{@attributes[attr]} model"
+
+          return unless @attributes[attr] != new_model
+          Rails.logger.warn "#{attr} now is mapped to #{new_model}"
+        end
+      end
+
+      def models
+        @models ||= []
+      end
+
+      def add_model(name)
+        @models ||= []
+        return if @models.include?(name.to_sym)
+        @models << name.to_sym
+      end
+
+      def validates_uniqueness_of(attribute, options = {})
+        options = { case_sensitive: false, attributes: [attribute],
+                    model: model_for(attribute) }
+                  .reverse_merge(options)
+        validates_with(validation_class_for(attribute), options)
+      end
+
+      def validation_class_for(attr)
+        model_klass = model_for(attr)
+        case
+        when model_klass.ancestors.include?(::Mongoid::Document)
+          'PathUtilities::Form::UniquenessValidator::Mongoid'
+        else
+          fail "#{model_klass.name} is not currently supported"
+        end.safe_constantize
+      end
+
+      def model_for(attr)
+        @attributes[attr] && @attributes[attr].options[:klass]
+      end
+
+      # mongoid-encrypted-fields gem compatibility method
+      def database_field_name(attribute)
+        attribute.to_sym
+      end
+    end
+  end
+end

data/lib/path_utilities/version.rb

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

data/lib/path_utilities.rb

@@ -0,0 +1,8 @@
+require "path_utilities/version"
+
+module PathUtilities
+  autoload :Form, 'path_utilities/form'
+end
+
+require 'mongoid'
+require 'virtus'

data/path_utilities.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'path_utilities/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'path_utilities'
+  spec.version       = PathUtilities::VERSION
+  spec.authors       = ['Ricard Forniol Agustí']
+  spec.email         = ['rforniol@path.travel']
+
+  spec.summary       = %q{Libraries and common used development strategies}
+  spec.description   = %q{At this moment includes a form validator strategy}
+  spec.homepage      = 'http://github.com/3mundi/path_utilities'
+  spec.license       = 'MIT'
+
+  files = ->(f) { f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject(&files)
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'byebug', '~> 5'
+  spec.add_development_dependency 'database_cleaner', '~> 1.4'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+
+  spec.add_dependency 'activemodel', '~> 4.2'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'virtus', '~> 1'
+  spec.add_dependency 'mongoid', '~> 4'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: path_utilities
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ricard Forniol Agustí
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: At this moment includes a form validator strategy
+email:
+- rforniol@path.travel
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/path_utilities.rb
+- lib/path_utilities/form.rb
+- lib/path_utilities/form/uniqueness_validator.rb
+- lib/path_utilities/form/uniqueness_validator/mongoid.rb
+- lib/path_utilities/version.rb
+- path_utilities.gemspec
+homepage: http://github.com/3mundi/path_utilities
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Libraries and common used development strategies
+test_files: []
+has_rdoc: