rom_factory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89b9204be8676e712c9615526bcd5dd26871ca0f
+  data.tar.gz: 924ac3c5c7317aa847c067b8923ae464a7750df3
+SHA512:
+  metadata.gz: 8c3d100354782edd3dba4718f8dbf7ec2b7ba9425d10acfc74cc726b50fa72591b9d937a88f92fd8aa323acd4adf3675ffe7aa8dd608d354efd74250c85ddc27
+  data.tar.gz: f7916356eb92878a012951aaad9ce87b35e95ba4c0347abf5bfeea28f03ba7de1391efaf3fd44cd13d5acde8de24dd7fe44c32e20cdbff1d7effa61a835f686b

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,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 janjiss@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 rom_factory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Janis Miezitis
+
+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,112 @@
+# RomFactory
+
+FactoryGirl is an awesome and ROM is awesome, hence RomFactory is born.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rom_factory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom_factory
+
+## Configuration
+First, you have to define ROM container:
+```ruby
+container = ROM.container(:sql, 'sqlite::memory') do |conf|
+  conf.default.create_table(:users) do
+    primary_key :id
+    column :last_name, String, null: false
+    column :first_name, String, null: false
+    column :email, String, null: false
+    column :created_at, Time, null: false
+    column :updated_at, Time, null: false
+  end
+end
+```
+Once that is done, you will have to specify which container RomFactory will use:
+```ruby
+RomFactory::Config.configure do |config|
+  config.container = container
+end
+```
+This library works in conjunction with "rom-repository" so you will need to define repository with create command:
+```ruby
+UsersRepo < ROM::Repository[:users] do
+  commands :create
+end
+```
+## Simple use case
+
+After configuration is done, you can define the factory as follows:
+```ruby
+RomFactory::Builder.define do |b|
+  b.factory(repo: UsersRepo, name: :user) do |f|
+    f.first_name "Janis"
+    f.last_name "Miezitis"
+    f.email "janjiss@gmail.com"
+  end
+end
+```
+When everything is configured, you can use it in your tests as follows:
+```ruby
+user = RomFactory::Builder.create(:user)
+user.email #=> "janjiss@gmail.com"
+```
+
+### Mapping of records
+To follow ROM conventions, you can pass any object that responds to `.call` method with `as:` key in following way:
+```ruby
+class User
+  def self.call(attrs)
+    self.new(attrs)
+  end
+
+  attr_reader :first_name, :last_name, :email
+
+  def initialize(first_name:, last_name:, email:)
+    @first_name, @last_name, @email = first_name, last_name, email
+  end
+end
+
+RomFactory::Builder.define do |b|
+  b.factory(repo: UsersRepo, name: :user, as: User) do |f|
+    f.first_name "Janis"
+    f.last_name "Miezitis"
+    f.email "janjiss@gmail.com"
+  end
+end
+
+user = RomFactory::Builder.create(:user)
+user.class #=> User
+```
+I would recommend using `dry-types` library or similar for creating your domain objects.
+
+### Callable properties
+You can easily define dynamic (callbale) properties if value needs to change every time it needs to be called. Anything that responds to `.call` can be dynamic property.
+```ruby
+RomFactory::Builder.define do |b|
+  b.factory(repo: UsersRepo, name: :user) do |f|
+    f.first_name "Janis"
+    f.last_name "Miezitis"
+    f.email "janjiss@gmail.com"
+    f.created_at {Time.now}
+  end
+end
+user = RomFactory::Builder.create(:user)
+user.created_at #=> 2016-08-27 18:17:08 -0500
+```
+
+
+
+## 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 "rom_factory"
+
+# 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/rom_factory/builder.rb

@@ -0,0 +1,57 @@
+module RomFactory
+  class Builder
+    @container = Dry::Container.new
+
+    def self.container
+      @container
+    end
+
+    def self.define(&block)
+      factory = new(&block)
+      raise ArgumentError, "Factory #{factory._name} already present" if container.key?(factory._name)
+      container.register(factory._name, factory)
+    end
+
+    def self.create(name, attrs = {})
+      factory = container.resolve(name)
+      schema = factory._schema.merge(attrs)
+      schema = schema.map do |k,v|
+        if v.respond_to?(:call)
+          [k, v.call]
+        else
+          [k, v]
+        end
+      end
+      record = factory._repo.create(schema.to_h)
+      factory._as ? factory._as.call(record.to_h) : record
+    end
+
+    def initialize
+      yield(self)
+    end
+
+    def factory(name:, repo:, as: nil, &block)
+      @_repo = repo.new(RomFactory::Config.config.container)
+      @_name = name
+      @_as = as
+      @_schema = {}
+      yield(self)
+    end
+
+    attr_reader :_repo, :_name, :_as, :_schema
+
+    private
+
+    def method_missing(name, *args, &block)
+      if @_repo.root.relation.attributes.include?(name)
+        if block_given?
+          @_schema[name] = block
+        else
+          @_schema[name] = args.first
+        end
+      else
+        raise NoMethodError, "undefined method `#{name}' for #{self}"
+      end
+    end
+  end
+end

data/lib/rom_factory/config.rb

@@ -0,0 +1,6 @@
+module RomFactory
+  class Config
+    extend Dry::Configurable
+    setting :container
+  end
+end

data/lib/rom_factory/version.rb

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

data/lib/rom_factory.rb

@@ -0,0 +1,13 @@
+require "pry"
+require "rom"
+require 'rom-repository'
+require 'dry-configurable'
+
+require "rom_factory/version"
+
+require "rom_factory/config"
+require "rom_factory/builder"
+
+module RomFactory
+  # Your code goes here...
+end

data/rom_factory.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rom_factory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rom_factory"
+  spec.version       = RomFactory::VERSION
+  spec.authors       = ["Janis Miezitis"]
+  spec.email         = ["janjiss@gmail.com"]
+
+  spec.summary       = %q{ROM based Factory girl inspired builder library to make your specs awesome}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  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'] = "https://rubygems.org"
+  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 { |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 "dry-configurable", "~> 0.1.7"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rom", "~> 2.0"
+  spec.add_development_dependency "rom-repository", "~> 0.3.1"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rom_factory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janis Miezitis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !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: 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: rom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rom-repository
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- janjiss@gmail.com
+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/rom_factory.rb
+- lib/rom_factory/builder.rb
+- lib/rom_factory/config.rb
+- lib/rom_factory/version.rb
+- rom_factory.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: ROM based Factory girl inspired builder library to make your specs awesome
+test_files: []