forminator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a10312bcdfaf0f6841f082e537d0c2cc81e62658
+  data.tar.gz: '09bbabf8629f41277171cb9cebbb0841f6430b51'
+SHA512:
+  metadata.gz: '093a385e799e850b1086f892abd4973789feca31f6af91e05809ce0a9c2cd442205321690706ba61180f5b7808be07c415111c07f28dc674fde1d9a3ceb350a1'
+  data.tar.gz: a5bc6a59e97e3cab7315ab105c6143819446d55a429c938df16d00c5833249ac95fb63e11f837586fd9ae34cfe9fe73c9f35c98886b146624c3657ebce982e21

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

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

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 wizard.oneandonly@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'
+
+# Specify your gem's dependencies in formator.gemspec
+gem 'byebug', require: false
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stefan Slaveykov
+
+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,117 @@
+# Forminator
+[![Build Status](https://travis-ci.org/wizardone/forminator.svg?branch=master)](https://travis-ci.org/wizardone/forminator)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forminator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install forminator
+
+## Usage
+First you need to configure the wizard so it knows the object that you
+interact with (usually a used model). If you like to persist the model you can
+supply a callable object that takes care of the persistence. Whether you
+want to persist after each step or after the final one is up to you.
+
+```ruby
+Forminator.configure do |config|
+  config.klass = :user
+  config.persist = -> (user) { user.save }
+end
+```
+To build a form wizard step you need to subclass the `Forminator::Step`
+class
+
+```ruby
+class FirstStep < Forminator::Step
+  validations do
+    required(:email) { filled? }
+    required(:password) { filled? }
+  end
+
+  # By default this returns false, so if you want to persist the object
+  # after each step you need to overwrite the method
+  def persist?
+    true
+  end
+end
+```
+Then you can do:
+```ruby
+user = User.new
+some_params = { email: 'test@test.com', password: 'ineedtocryptmypassword' }
+FirstStep.(user, some_params)
+=> [{ valid: true }, some_params]
+```
+Each step always returns an array of 2 elements: a hash with the
+validity and the initially passed params. This allows for easy chaining
+of events.
+
+
+If you want to call a custom persistence logic for a certain step you
+can pass an optionable callable object like so:
+
+```ruby
+class CustomPersistenceLogic
+  def call(user)
+    # persistence logic goes here
+  end
+end
+user = User.new
+FirstStep.(user, some_params, persist: CustomPersistenceLogic.new)
+```
+The callable object will receive the original object that you interact
+with.
+
+Want to build a whole flow of steps? Just use the `Forminator::Flow`
+class
+```ruby
+steps = [FirstStep, SecondStep, LastStep]
+flow = Forminator::Flow.new(steps: steps)
+flow.current_step
+=> FirstStep
+flow.next_step
+=> SecondStep
+```
+You can also add steps on the way with:
+```ruby
+flow.add(step: IntermediateStep)
+```
+Keep in mind that you can only add steps that inherit from
+`Forminator::Step`.
+You can also remove steps:
+```ruby
+flow.remove(step: LastStep)
+=> LastStep
+```
+Calling `remove` will return the removed step.
+
+`Forminator` uses `Hanami::Validations` which in it's own term uses
+`Dry::Validation` :heart. You can [refer](https://github.com/hanami/validations) them for a detailed DSL about
+validations.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/wizardone/forminator. 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,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 "forminator"
+
+# 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(__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/forminator.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forminator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forminator"
+  spec.version       = Forminator::VERSION
+  spec.authors       = ["Stefan Slaveykov"]
+  spec.email         = ["wizard.oneandonly@gmail.com"]
+
+  spec.summary       = %q{Ruby form wizard}
+  spec.description   = %q{Ruby form wizard, not coupled to any specific framework}
+  spec.homepage      = "https://github.com/wizardone/forminator"
+  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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "hanami-validations", "~> 1.0.0"
+end

data/lib/forminator.rb

@@ -0,0 +1,19 @@
+require 'forminator/version'
+require 'forminator/config'
+require 'forminator/flow'
+require 'forminator/step'
+
+module Forminator
+
+  class << self
+    attr_reader :config
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/forminator/config.rb

@@ -0,0 +1,5 @@
+module Forminator
+  class Config
+    attr_accessor :klass, :steps, :persist
+  end
+end

data/lib/forminator/flow.rb

@@ -0,0 +1,32 @@
+module Forminator
+  class Flow
+    attr_reader :steps, :current_step
+
+    def initialize(steps:)
+      @steps = steps
+      @current_step = initial_step
+    end
+
+    def next_step
+      steps[steps.index(current_step) + 1]
+    end
+
+    def previous_step
+      # TODO: there is no previous step??
+      steps[steps.index(current_step) - 1]
+    end
+
+    def initial_step
+      steps.first
+    end
+
+    def add(step:)
+      raise Forminator::InvalidStep unless step.ancestors.include?(Forminator::Step)
+      steps << step
+    end
+
+    def remove(step:)
+      steps.delete(step)
+    end
+  end
+end

data/lib/forminator/step.rb

@@ -0,0 +1,36 @@
+require 'hanami/validations'
+
+module Forminator
+
+  class InvalidStep < StandardError; end
+
+  class Step
+
+    include ::Hanami::Validations
+
+    attr_reader :params, :object
+
+    def self.call(object, params, **options)
+      step = new(params)
+      validity = step.valid?
+      if validity && step.persist?
+        step.persist(object: object, persist: options[:persist])
+      end
+
+      [{ valid: validity }, params]
+    end
+
+    def valid?
+      validate.success?
+    end
+
+    def persist?
+      false
+    end
+
+    def persist(object:, persist: nil)
+      persist&.call(object) ||
+      Forminator.config.persist.call(object)
+    end
+  end
+end

data/lib/forminator/version.rb

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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: forminator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Slaveykov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: hanami-validations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Ruby form wizard, not coupled to any specific framework
+email:
+- wizard.oneandonly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- forminator.gemspec
+- lib/forminator.rb
+- lib/forminator/config.rb
+- lib/forminator/flow.rb
+- lib/forminator/step.rb
+- lib/forminator/version.rb
+homepage: https://github.com/wizardone/forminator
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby form wizard
+test_files: []