usine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbc2a69385641d964ee71c8d4aec4dca3237fbea
+  data.tar.gz: 50b1d8c0d0eb7d9f122bc3abf59dbb35da29b7cc
+SHA512:
+  metadata.gz: 898bc72b754b1eca6709814eef4424e5d199273d8ba4a88fd38a7f16a59faf11dc04a9a02949c7fa336d0ac46277290f6bb4e5009ba2f90babaa200081a253f9
+  data.tar.gz: 211d45fe40c5457f3313e9802413e2d478c69541c423b16b4a0bc09528b25e0f0fd292602f21091f2dd9db22a2ec2b558aca11e0a9d6afa9b3b8bae2e76f0c37

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.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at j.jaffeux@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joffrey JAFFEUX
+
+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,93 @@
+# Usine
+
+Usine (french word for factory) is a small gem aiming to bring a limited feature set of factory_girl
+when using Trailblazer’s operations. [Trailblazer](http://trailblazer.to/) advocates against using factory_girl to avoid
+differences when initializing objects. Usine follows this path but allows you to define defaults for the
+parameters passed to your operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'usine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install usine
+
+## Usage
+
+### Create definitions to be used by factories
+
+```ruby
+Usine.definition(Item::Create) do
+  title { "Some title" }
+end
+```
+
+Definition accept unlimited args after the operation class, to allow you to share
+definitions.
+
+```ruby
+SendableDefinition = proc {
+  sendable { false }
+}
+
+Usine.definition(Item::Create, SendableDefinition) do
+  title { "Some title" }
+end
+
+Usine.definition(Item::Update, SendableDefinition) do
+  title { "Some title" }
+end
+```
+
+### Using factories
+
+Usine respects Trailblazer naming differences when creating an operation : call, run and present.
+
+```ruby
+Usine.(Item::Create, title: "different title")
+Usine.call(Item::Create, title: "different title")
+Usine.run(Item::Create, title: "different title")
+Usine.present(Item::Create, title: "different title")
+```
+
+`present` for example can be used to access model/contract without calling process in the operation.
+
+### Sequences
+
+```ruby
+# global sequence
+Usine.sequence(:title) do |n|
+  "title number #{n}"
+end
+
+# if no block is passed to the attribute, it will call generate(:attribute_name)
+Usine.definition(Item::Create) do
+  title #title number 1
+  subtitle { generate(:title) } #title number 2
+end
+
+# inline sequence with different initial value
+Usine.definition(Item::Create) do
+  sequence(:title, 'a')
+  title #title number a
+  subtitle { generate(:title) } #title number b
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jjaffeux/usine. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "usine"
+
+# 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,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/lib/usine.rb

@@ -0,0 +1,43 @@
+require "usine/version"
+require "usine/factory"
+require "usine/exceptions"
+require "usine/evaluator"
+require "usine/definition"
+require "usine/sequence"
+require "uber/inheritable_attr"
+
+module Usine
+  extend Uber::InheritableAttr
+  inheritable_attr :definitions
+  self.definitions = {}
+  inheritable_attr :sequences
+  self.sequences = []
+
+  class << self
+    def call(*args)
+      Factory.(:call, args.shift, args.shift)
+    end
+
+    def run(*args)
+      Factory.(:run, args.shift, args.shift)
+    end
+
+    def present(*args)
+      Factory.(:present, args.shift, args.shift)
+    end
+
+    def sequence(name, initial_value = 1, &block)
+      self.sequences << Sequence.new(name, initial_value, &block)
+    end
+
+    def definition(operation, *extensions, &block)
+      self.definitions[operation] ||= []
+
+      self.definitions[operation] << Definition.new(operation, &block)
+
+      extensions.each do |extension|
+        self.definitions[operation] << Definition.new(operation, &block)
+      end
+    end
+  end
+end

data/lib/usine/definition.rb

@@ -0,0 +1,11 @@
+module Usine
+  class Definition
+    attr_reader :name
+    attr_reader :block
+
+    def initialize(name, *args, &block)
+      @name = name
+      @block = block
+    end
+  end
+end

data/lib/usine/evaluator.rb

@@ -0,0 +1,35 @@
+module Usine
+  class Evaluator
+    attr_reader :attributes
+    attr_reader :sequences
+    attr_reader :scoped_sequences
+
+    def initialize(sequences = {})
+      @sequences = sequences
+      @scoped_sequences = []
+      @attributes = {}
+    end
+
+    def method_missing(method_symbol, *args, &block)
+      if block
+        @attributes[method_symbol] = block.call
+      else
+        @attributes[method_symbol] = generate(method_symbol)
+      end
+    end
+
+    def generate(attribute)
+      if sequence = scoped_sequences.detect { |x| x.attribute == attribute }
+        sequence.next
+      elsif sequence = sequences.detect { |x| x.attribute == attribute }
+        sequence.next
+      else
+        raise(UsineError::SequenceNotFound, "Couldn’t find a sequence named : `#{attribute}`")
+      end
+    end
+
+    def sequence(name, initial_value = 1, &block)
+      @scoped_sequences << Sequence.new(name, initial_value, &block)
+    end
+  end
+end

data/lib/usine/exceptions.rb

@@ -0,0 +1,11 @@
+class UsineError < StandardError
+end
+
+class UsineError::DefinitionNotFound < UsineError
+end
+
+class UsineError::SequenceNotFound < UsineError
+end
+
+class UsineError::SequenceInvalidInitialValue < UsineError
+end

data/lib/usine/factory.rb

@@ -0,0 +1,55 @@
+module Usine
+  class Factory
+    attr_reader :mode
+    attr_reader :operation
+    attr_reader :attributes
+    attr_accessor :definition
+
+    def self.call(mode, operation, attributes = {})
+      factory = new(mode, operation, attributes, definitions)
+      factory.process!
+    end
+
+    def initialize(mode, operation, attributes = {})
+      @mode = mode
+      @operation = operation
+      @definitions = attributes.delete(:definitions) || Usine.definitions.fetch(operation, [])
+      @sequences = attributes.delete(:sequences) || Usine.sequences
+      @attributes = attributes || {}
+    end
+
+    def process!
+      @operation.send(@mode, merged_attributes)
+    end
+
+    def merged_attributes
+      evaluated_factory.attributes.merge(@attributes)
+    end
+
+    def evaluated_factory
+      @evaluated_factory ||= evaluate_with_definitions(@sequences)
+    end
+
+    protected
+
+    def filtered_definitions
+      filtered = @definitions.select do |definition|
+        definition.name == @operation
+      end
+
+      if filtered.empty?
+        raise UsineError::DefinitionNotFound, "No definition found for `#{@operation}`"
+      end
+
+      filtered
+    end
+
+    def evaluate_with_definitions(sequences)
+      evaluator = Evaluator.new(sequences)
+      filtered_definitions.each do |definition|
+        evaluator.instance_eval(&definition.block)
+      end
+      evaluator
+    end
+  end
+end

data/lib/usine/sequence.rb

@@ -0,0 +1,21 @@
+module Usine
+  class Sequence
+    attr_reader :attribute
+
+    def initialize(attribute, *args, &block)
+      @attribute = attribute
+      @block = block
+      @value = args.first || 1
+
+      unless @value.respond_to?(:next)
+        raise(UsineError::SequenceInvalidInitialValue, "Invalid initial value, it must respond to #next")
+      end
+    end
+
+    def next
+      @block.call(@value)
+    ensure
+      @value = @value.next
+    end
+  end
+end

data/lib/usine/version.rb

@@ -0,0 +1,3 @@
+module Usine
+  VERSION = "1.0.0"
+end

data/usine.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "usine"
+  spec.version       = Usine::VERSION
+  spec.authors       = ["Joffrey JAFFEUX"]
+  spec.email         = ["j.jaffeux@gmail.com"]
+
+  spec.summary       = %q{Factories for Trailblazer’s operations}
+  spec.description   = %q{Usine (french word for factory) is a small gem aiming to bring a limited feature set of factory_girl when using Trailblazer’s operations.}
+  spec.homepage      = "https://github.com/jjaffeux/usine"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             "uber"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "trailblazer", "~> 1.1"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: usine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joffrey JAFFEUX
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: trailblazer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Usine (french word for factory) is a small gem aiming to bring a limited
+  feature set of factory_girl when using Trailblazer’s operations.
+email:
+- j.jaffeux@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
+- lib/usine.rb
+- lib/usine/definition.rb
+- lib/usine/evaluator.rb
+- lib/usine/exceptions.rb
+- lib/usine/factory.rb
+- lib/usine/sequence.rb
+- lib/usine/version.rb
+- usine.gemspec
+homepage: https://github.com/jjaffeux/usine
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Factories for Trailblazer’s operations
+test_files: []
+has_rdoc: