usine 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: fbc2a69385641d964ee71c8d4aec4dca3237fbea
4
+ data.tar.gz: 50b1d8c0d0eb7d9f122bc3abf59dbb35da29b7cc
5
+ SHA512:
6
+ metadata.gz: 898bc72b754b1eca6709814eef4424e5d199273d8ba4a88fd38a7f16a59faf11dc04a9a02949c7fa336d0ac46277290f6bb4e5009ba2f90babaa200081a253f9
7
+ data.tar.gz: 211d45fe40c5457f3313e9802413e2d478c69541c423b16b4a0bc09528b25e0f0fd292602f21091f2dd9db22a2ec2b558aca11e0a9d6afa9b3b8bae2e76f0c37
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at j.jaffeux@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in usine.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Joffrey JAFFEUX
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,93 @@
1
+ # Usine
2
+
3
+ Usine (french word for factory) is a small gem aiming to bring a limited feature set of factory_girl
4
+ when using Trailblazer’s operations. [Trailblazer](http://trailblazer.to/) advocates against using factory_girl to avoid
5
+ differences when initializing objects. Usine follows this path but allows you to define defaults for the
6
+ parameters passed to your operations.
7
+
8
+ ## Installation
9
+
10
+ Add this line to your application's Gemfile:
11
+
12
+ ```ruby
13
+ gem 'usine'
14
+ ```
15
+
16
+ And then execute:
17
+
18
+ $ bundle
19
+
20
+ Or install it yourself as:
21
+
22
+ $ gem install usine
23
+
24
+ ## Usage
25
+
26
+ ### Create definitions to be used by factories
27
+
28
+ ```ruby
29
+ Usine.definition(Item::Create) do
30
+ title { "Some title" }
31
+ end
32
+ ```
33
+
34
+ Definition accept unlimited args after the operation class, to allow you to share
35
+ definitions.
36
+
37
+ ```ruby
38
+ SendableDefinition = proc {
39
+ sendable { false }
40
+ }
41
+
42
+ Usine.definition(Item::Create, SendableDefinition) do
43
+ title { "Some title" }
44
+ end
45
+
46
+ Usine.definition(Item::Update, SendableDefinition) do
47
+ title { "Some title" }
48
+ end
49
+ ```
50
+
51
+ ### Using factories
52
+
53
+ Usine respects Trailblazer naming differences when creating an operation : call, run and present.
54
+
55
+ ```ruby
56
+ Usine.(Item::Create, title: "different title")
57
+ Usine.call(Item::Create, title: "different title")
58
+ Usine.run(Item::Create, title: "different title")
59
+ Usine.present(Item::Create, title: "different title")
60
+ ```
61
+
62
+ `present` for example can be used to access model/contract without calling process in the operation.
63
+
64
+ ### Sequences
65
+
66
+ ```ruby
67
+ # global sequence
68
+ Usine.sequence(:title) do |n|
69
+ "title number #{n}"
70
+ end
71
+
72
+ # if no block is passed to the attribute, it will call generate(:attribute_name)
73
+ Usine.definition(Item::Create) do
74
+ title #title number 1
75
+ subtitle { generate(:title) } #title number 2
76
+ end
77
+
78
+ # inline sequence with different initial value
79
+ Usine.definition(Item::Create) do
80
+ sequence(:title, 'a')
81
+ title #title number a
82
+ subtitle { generate(:title) } #title number b
83
+ end
84
+ ```
85
+
86
+ ## Contributing
87
+
88
+ 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.
89
+
90
+
91
+ ## License
92
+
93
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "usine"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,43 @@
1
+ require "usine/version"
2
+ require "usine/factory"
3
+ require "usine/exceptions"
4
+ require "usine/evaluator"
5
+ require "usine/definition"
6
+ require "usine/sequence"
7
+ require "uber/inheritable_attr"
8
+
9
+ module Usine
10
+ extend Uber::InheritableAttr
11
+ inheritable_attr :definitions
12
+ self.definitions = {}
13
+ inheritable_attr :sequences
14
+ self.sequences = []
15
+
16
+ class << self
17
+ def call(*args)
18
+ Factory.(:call, args.shift, args.shift)
19
+ end
20
+
21
+ def run(*args)
22
+ Factory.(:run, args.shift, args.shift)
23
+ end
24
+
25
+ def present(*args)
26
+ Factory.(:present, args.shift, args.shift)
27
+ end
28
+
29
+ def sequence(name, initial_value = 1, &block)
30
+ self.sequences << Sequence.new(name, initial_value, &block)
31
+ end
32
+
33
+ def definition(operation, *extensions, &block)
34
+ self.definitions[operation] ||= []
35
+
36
+ self.definitions[operation] << Definition.new(operation, &block)
37
+
38
+ extensions.each do |extension|
39
+ self.definitions[operation] << Definition.new(operation, &block)
40
+ end
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,11 @@
1
+ module Usine
2
+ class Definition
3
+ attr_reader :name
4
+ attr_reader :block
5
+
6
+ def initialize(name, *args, &block)
7
+ @name = name
8
+ @block = block
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,35 @@
1
+ module Usine
2
+ class Evaluator
3
+ attr_reader :attributes
4
+ attr_reader :sequences
5
+ attr_reader :scoped_sequences
6
+
7
+ def initialize(sequences = {})
8
+ @sequences = sequences
9
+ @scoped_sequences = []
10
+ @attributes = {}
11
+ end
12
+
13
+ def method_missing(method_symbol, *args, &block)
14
+ if block
15
+ @attributes[method_symbol] = block.call
16
+ else
17
+ @attributes[method_symbol] = generate(method_symbol)
18
+ end
19
+ end
20
+
21
+ def generate(attribute)
22
+ if sequence = scoped_sequences.detect { |x| x.attribute == attribute }
23
+ sequence.next
24
+ elsif sequence = sequences.detect { |x| x.attribute == attribute }
25
+ sequence.next
26
+ else
27
+ raise(UsineError::SequenceNotFound, "Couldn’t find a sequence named : `#{attribute}`")
28
+ end
29
+ end
30
+
31
+ def sequence(name, initial_value = 1, &block)
32
+ @scoped_sequences << Sequence.new(name, initial_value, &block)
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,11 @@
1
+ class UsineError < StandardError
2
+ end
3
+
4
+ class UsineError::DefinitionNotFound < UsineError
5
+ end
6
+
7
+ class UsineError::SequenceNotFound < UsineError
8
+ end
9
+
10
+ class UsineError::SequenceInvalidInitialValue < UsineError
11
+ end
@@ -0,0 +1,55 @@
1
+ module Usine
2
+ class Factory
3
+ attr_reader :mode
4
+ attr_reader :operation
5
+ attr_reader :attributes
6
+ attr_accessor :definition
7
+
8
+ def self.call(mode, operation, attributes = {})
9
+ factory = new(mode, operation, attributes, definitions)
10
+ factory.process!
11
+ end
12
+
13
+ def initialize(mode, operation, attributes = {})
14
+ @mode = mode
15
+ @operation = operation
16
+ @definitions = attributes.delete(:definitions) || Usine.definitions.fetch(operation, [])
17
+ @sequences = attributes.delete(:sequences) || Usine.sequences
18
+ @attributes = attributes || {}
19
+ end
20
+
21
+ def process!
22
+ @operation.send(@mode, merged_attributes)
23
+ end
24
+
25
+ def merged_attributes
26
+ evaluated_factory.attributes.merge(@attributes)
27
+ end
28
+
29
+ def evaluated_factory
30
+ @evaluated_factory ||= evaluate_with_definitions(@sequences)
31
+ end
32
+
33
+ protected
34
+
35
+ def filtered_definitions
36
+ filtered = @definitions.select do |definition|
37
+ definition.name == @operation
38
+ end
39
+
40
+ if filtered.empty?
41
+ raise UsineError::DefinitionNotFound, "No definition found for `#{@operation}`"
42
+ end
43
+
44
+ filtered
45
+ end
46
+
47
+ def evaluate_with_definitions(sequences)
48
+ evaluator = Evaluator.new(sequences)
49
+ filtered_definitions.each do |definition|
50
+ evaluator.instance_eval(&definition.block)
51
+ end
52
+ evaluator
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,21 @@
1
+ module Usine
2
+ class Sequence
3
+ attr_reader :attribute
4
+
5
+ def initialize(attribute, *args, &block)
6
+ @attribute = attribute
7
+ @block = block
8
+ @value = args.first || 1
9
+
10
+ unless @value.respond_to?(:next)
11
+ raise(UsineError::SequenceInvalidInitialValue, "Invalid initial value, it must respond to #next")
12
+ end
13
+ end
14
+
15
+ def next
16
+ @block.call(@value)
17
+ ensure
18
+ @value = @value.next
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,3 @@
1
+ module Usine
2
+ VERSION = "1.0.0"
3
+ end
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'usine/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "usine"
8
+ spec.version = Usine::VERSION
9
+ spec.authors = ["Joffrey JAFFEUX"]
10
+ spec.email = ["j.jaffeux@gmail.com"]
11
+
12
+ spec.summary = %q{Factories for Trailblazer’s operations}
13
+ 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.}
14
+ spec.homepage = "https://github.com/jjaffeux/usine"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency "uber"
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.12"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "minitest", "~> 5.0"
27
+ spec.add_development_dependency "trailblazer", "~> 1.1"
28
+ end
metadata ADDED
@@ -0,0 +1,133 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: usine
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Joffrey JAFFEUX
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-07-22 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: uber
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.12'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.12'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: minitest
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '5.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '5.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: trailblazer
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.1'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.1'
83
+ description: Usine (french word for factory) is a small gem aiming to bring a limited
84
+ feature set of factory_girl when using Trailblazer’s operations.
85
+ email:
86
+ - j.jaffeux@gmail.com
87
+ executables: []
88
+ extensions: []
89
+ extra_rdoc_files: []
90
+ files:
91
+ - ".gitignore"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - lib/usine.rb
101
+ - lib/usine/definition.rb
102
+ - lib/usine/evaluator.rb
103
+ - lib/usine/exceptions.rb
104
+ - lib/usine/factory.rb
105
+ - lib/usine/sequence.rb
106
+ - lib/usine/version.rb
107
+ - usine.gemspec
108
+ homepage: https://github.com/jjaffeux/usine
109
+ licenses:
110
+ - MIT
111
+ metadata: {}
112
+ post_install_message:
113
+ rdoc_options: []
114
+ require_paths:
115
+ - lib
116
+ required_ruby_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ required_rubygems_version: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - ">="
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ requirements: []
127
+ rubyforge_project:
128
+ rubygems_version: 2.5.1
129
+ signing_key:
130
+ specification_version: 4
131
+ summary: Factories for Trailblazer’s operations
132
+ test_files: []
133
+ has_rdoc: