ciesta 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e648671453a91e2f62c7db71603ad9dbcea1606c2d5404fca7708a54a9a177a
+  data.tar.gz: 1067bcb0dc3b31f64090981b2ed4e9c0a102b02fd9aedca04c99114cb10ae8e4
+SHA512:
+  metadata.gz: 4b2f569ade3113c3060f38bcecbc84063dcab3821d1237b0d6f95979dfdafd19ba3e5ca6590d635eb24726ef699d9399305677c95539b1fadd9b85e39cddc29c
+  data.tar.gz: 10aff7f55262f29b3983167f76f76fadb50e2a1f067b29e6a778e8204af173ac7b4abcbc299596f2cde405e71f9404842cd0dbe32efeeb2e77d22a9afe3e1339

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+sudo: false
+language: ruby
+cache: bundler
+before_install: gem install bundler
+script: bundle exec rspec
+rvm:
+  - ruby-head
+  - 2.4.2
+  - 2.4.0
+  - 2.3.5
+  - 2.3.1
+  - 2.2.5
+  - 2.2.0

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 alex.coder1@gmail.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,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    ciesta (0.1.0)
+      dry-types (~> 0.12.1)
+      dry-validation (~> 0.11.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.4)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.0)
+    dry-logic (0.4.2)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (0.12.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.2)
+      inflecto (~> 0.0.0, >= 0.0.2)
+    dry-validation (0.11.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      dry-types (~> 0.12.0)
+    inflecto (0.0.2)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ciesta!
+  coveralls (~> 0.8)
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexey
+
+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,111 @@
+# Ciesta
+
+[![Coverage Status](https://coveralls.io/repos/github/nulldef/ciesta/badge.svg?branch=master)](https://coveralls.io/github/nulldef/ciesta?branch=master)
+[![Build Status](https://travis-ci.org/nulldef/ciesta.svg?branch=master)](https://travis-ci.org/nulldef/ciesta)
+
+Create simple form objects
+
+Supported Ruby 2.2.0+
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic usage](#basic-usage)
+  - [Assign values](#assign-values)
+  - [Syncing attributes](#syncing-attributes)
+  - [Types](#types)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ciesta'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statum
+
+## Usage
+
+### Basic usage
+
+For validation it uses [dry-validation](https://github.com/dry-rb/dry-validation) under the hood. You can use all features of validation provided there.
+
+```ruby
+User = Struct.new(:name, :age)
+
+class Form < Ciesta::Form
+  field :name
+  field :age
+
+  validate do
+    required(:name).filled
+    required(:age).filled(gt?: 18)
+  end
+end
+```
+
+And use it
+
+```ruby
+user = User.new("John", nil)
+form = Form.new(user)
+form.valid?(age: 10) # => false
+form.valid?(age: 20) # => true
+```
+
+### Assign values
+
+You can assign values to form with two methods `assign!` and `assign`
+
+```ruby
+class Form < Ciesta::Form
+  field :bar
+end
+
+form.assign!(foo: 1, bar: 2) # => raises Ciesta::FieldNotDefined
+...
+form.assign(foo: 1, bar: 2)
+form.foo # => 1
+```
+
+You can pass attributes directly to `valid?` method. In this case `assing` method will be used.
+
+### Syncing attributes
+
+You can use methods `sync` and `sync!` for mapping form values to the object. The difference is only that the second one will raise error if form is invalid.
+
+```ruby
+form.valid?(age: 10)
+form.sync! # => raises Ciesta::NotValid
+form.sync  # => returns nil
+```
+
+### Types
+
+You can provide the type of each field for ciercing or checking one. All types provided by [dry-types](https://github.com/dry-rb/dry-types) but in gem's namespace.
+
+```ruby
+class Form < Ciesta::Form
+  field :foo, type: Ciesta::Types::Coercible::String
+end
+
+# ...
+form.assign(foo: 1) # => true
+form.foo            # => "1"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/nulldef/ciesta](https://github.com/nulldef/ciesta).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ciesta'
+
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

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

data/ciesta.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ciesta/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ciesta'
+  spec.version       = Ciesta::VERSION
+  spec.authors       = ['Alexey']
+  spec.email         = ['alex.coder1@gmail.com']
+
+  spec.summary       = 'Create form objects easy'
+  spec.description   = 'Gem for creating and using form object'
+  spec.homepage      = 'https://github.com/nulldef/ciesta'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  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.required_ruby_version = ">= 2.0"
+
+  spec.add_dependency 'dry-types', '~> 0.12.1'
+  spec.add_dependency 'dry-validation', '~> 0.11.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/ciesta.rb

@@ -0,0 +1,11 @@
+require 'dry-types'
+require 'dry-validation'
+require 'ciesta/version'
+require 'ciesta/types'
+require 'ciesta/validator'
+require 'ciesta/errors'
+require 'ciesta/field'
+require 'ciesta/form'
+
+module Ciesta
+end

data/lib/ciesta/errors.rb

@@ -0,0 +1,5 @@
+module Ciesta
+  ViolatesConstraints = Class.new(ArgumentError)
+  NotValid = Class.new(StandardError)
+  FieldNotDefined = Class.new(NoMethodError)
+end

data/lib/ciesta/field.rb

@@ -0,0 +1,27 @@
+module Ciesta
+  class Field
+    DEFAULT_TYPE = Ciesta::Types::Any
+
+    attr_accessor :name, :type
+
+    def initialize(name, options)
+      self.name = name.to_sym
+      self.type = options.delete(:type) || DEFAULT_TYPE
+      self.value = options.delete(:default)
+    end
+
+    def value
+      current_value
+    end
+
+    def value=(val)
+      self.current_value = type[val]
+    rescue Dry::Types::ConstraintError
+      raise ViolatesConstraints, "#{current_value} is not a #{type.name}"
+    end
+
+    private
+
+    attr_accessor :current_value
+  end
+end

data/lib/ciesta/form.rb

@@ -0,0 +1,91 @@
+module Ciesta
+  class Form
+    def self.field(name, options = {})
+      name = name.to_sym
+      fields[name] ||= Ciesta::Field.new(name, options)
+
+      define_method(name) { self.class.fields[name].value }
+      define_method("#{name}=") { |value| self.class.fields[name].value = value }
+    end
+
+    def self.validate(&block)
+      validator.use(&block)
+    end
+
+    attr_accessor :object
+
+    def initialize(object)
+      self.object = object
+
+      obj_values = fields.keys.each_with_object({}) do |key, mem|
+        mem[key] = object.public_send(key)
+      end
+
+      assign(obj_values)
+    end
+
+    def valid?(params = nil)
+      assign(params) if params
+      validator.valid?(attributes)
+    end
+
+    def assign!(attributes)
+      attributes.each { |key, value| send("#{key}=", value) }
+    rescue NoMethodError => e
+      raise Ciesta::FieldNotDefined, e.message
+    end
+
+    def assign(params)
+      keys = fields.keys
+      params.keep_if { |key, _value| keys.include?(key) }
+      begin
+        assign!(params)
+      rescue StandardError
+        nil
+      end
+    end
+
+    def errors
+      validator.errors
+    end
+
+    def sync!
+      raise Ciesta::NotValid, 'Form is not valid' unless errors.empty?
+
+      fields.each { |name, field| object.send("#{name}=", field.value) }
+
+      yield(object) if block_given?
+      true
+    end
+
+    def sync
+      sync!
+    rescue StandardError
+      nil
+    end
+
+    private
+
+    def self.fields
+      @fields ||= {}
+    end
+
+    def self.validator
+      @validator ||= Ciesta::Validator.new
+    end
+
+    def validator
+      self.class.validator
+    end
+
+    def fields
+      self.class.fields
+    end
+
+    def attributes
+      fields.values.each_with_object({}) do |field, mem|
+        mem[field.name] = field.value
+      end
+    end
+  end
+end

data/lib/ciesta/types.rb

@@ -0,0 +1,5 @@
+module Ciesta
+  module Types
+    include Dry::Types.module
+  end
+end

data/lib/ciesta/validator.rb

@@ -0,0 +1,20 @@
+module Ciesta
+  class Validator
+    attr_accessor :schema, :errors
+
+    def initialize
+      self.errors = []
+    end
+
+    def use(&block)
+      self.schema = Dry::Validation.Form(&block)
+    end
+
+    def valid?(attributes)
+      return true if schema.nil?
+
+      self.errors = schema.call(attributes).errors
+      errors.empty?
+    end
+  end
+end

data/lib/ciesta/version.rb

@@ -0,0 +1,3 @@
+module Ciesta
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: ciesta
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Gem for creating and using form object
+email:
+- alex.coder1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ciesta.gemspec
+- lib/ciesta.rb
+- lib/ciesta/errors.rb
+- lib/ciesta/field.rb
+- lib/ciesta/form.rb
+- lib/ciesta/types.rb
+- lib/ciesta/validator.rb
+- lib/ciesta/version.rb
+homepage: https://github.com/nulldef/ciesta
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Create form objects easy
+test_files: []