factory_enforcer 0.1.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fec73ea2df6d23b15e61fdafbbd2a23b2c0f06f
+  data.tar.gz: 3ca9a6e80cfa810909cd646b8995e5c409fb5ebc
+SHA512:
+  metadata.gz: a948c5d2ab9fac692769bbbecbee10fa4ba84498ed3ff1cf8345afa8a2c8840e45571afcab1d83e72ff6ec18f3d3ab3a64ca36c1a6c6265dbbcdb41476fbe236
+  data.tar.gz: 2f62f3f94262be99e4262c329eeb917a30b3d9d7d734cc07bc69210ed5b10029a9485da87b9357dde3506e0a3c74b5b3e1d529ecbe3d3d6bf2f05bc4c6ae1b82

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Max: 80
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'factory_enforcer.gemspec'
+
+Style/Documentation:
+  Enabled: false<Paste>

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in factory_enforcer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    factory_enforcer (0.1.0.pre1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  factory_enforcer!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 James Stonehill
+
+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,39 @@
+# FactoryEnforcer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/factory_enforcer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'factory_enforcer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install factory_enforcer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/factory_enforcer.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "factory_enforcer"
+
+# 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/factory_enforcer.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "factory_enforcer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "factory_enforcer"
+  spec.version       = FactoryEnforcer::VERSION
+  spec.authors       = ["James Stonehill"]
+  spec.email         = ["jamesstonehill@gmail.com"]
+
+  spec.summary       = "Enforce usage of the factory pattern with factory_enforcer"
+  spec.description   = "Enforce usage of the factory pattern with factory_enforcer"
+  spec.homepage      = "https://github.com/jamesstonehill/factory_enforcer"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/factory_enforcer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "factory_enforcer/exceptions"
+require "factory_enforcer/version"
+require "factory_enforcer/method"
+
+module FactoryEnforcer
+  def new(*args, &block)
+    if should_enforce_factory_usage?
+      factory_class = UserFactory
+
+      factory_methods = Method.all_from_class(factory_class)
+      factory_caller_patterns = factory_methods.map(&:caller_pattern)
+
+      called_from_factory_method = caller.any? do |call_trace|
+        factory_caller_patterns.any? do |format_pattern|
+          format_pattern.match?(call_trace)
+        end
+      end
+
+      unless called_from_factory_method
+        raise FactoryNotUsed.new(self.class, factory_class)
+      end
+    end
+
+    super
+  end
+
+  def should_enforce_factory_usage?
+    true
+  end
+end

data/lib/factory_enforcer/exceptions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FactoryEnforcer
+  class FactoryNotUsed < StandardError
+    def initialize(class_name, factory_class)
+      super(
+        "Factory usage is enfoced for the #{class_name} class. You must use the #{factory_class} to contstruct #{class_name} instances"
+      )
+    end
+  end
+end

data/lib/factory_enforcer/method.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module FactoryEnforcer
+  class Method
+    def self.all_from_class(klass)
+      instance_methods = klass.instance_methods(false).map do |method_name|
+        new(klass, method_name, instance_method: true)
+      end
+      class_methods = klass.methods(false).map do |method_name|
+        new(klass, method_name, instance_method: false)
+      end
+
+      instance_methods + class_methods
+    end
+
+    def initialize(klass, method_name, instance_method:)
+      @method_name = method_name
+
+      @method = if instance_method
+                  klass.instance_method(method_name)
+                else
+                  klass.method(method_name)
+                end
+    end
+
+    def caller_pattern
+      /^#{location[0]}:\d:in\s`#{@method_name}'$/
+    end
+
+    private
+
+    def location
+      @method.source_location
+    end
+  end
+end

data/lib/factory_enforcer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FactoryEnforcer
+  VERSION = "0.1.0.pre1"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: factory_enforcer
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- James Stonehill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: byebug
+  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'
+- !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: Enforce usage of the factory pattern with factory_enforcer
+email:
+- jamesstonehill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- factory_enforcer.gemspec
+- lib/factory_enforcer.rb
+- lib/factory_enforcer/exceptions.rb
+- lib/factory_enforcer/method.rb
+- lib/factory_enforcer/version.rb
+homepage: https://github.com/jamesstonehill/factory_enforcer
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: Enforce usage of the factory pattern with factory_enforcer
+test_files: []