cliches 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ac6a4b5c4994d38b7238164ab96125e12e41e16
+  data.tar.gz: 832f4b2fe2e3c3791eb34b7a1ec7ec29e26c8fcb
+SHA512:
+  metadata.gz: 0f810a89b1cc1242223ea0540dfe3d4c6a8e25818ffb3bd5117de6fc51de71cb48c0e5be415975dc5784f89428b015d4a13e9967463224e2f652de63dd86ad20
+  data.tar.gz: d9950a97eb8788a94a2d38e226f14bdd977c09a989d37f1b0d0e4518b86d3a59d9479773989cc7e8e91798289dd77a250c27ea733fa0ab32ab20977e799cb473

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+html/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+/.ruby-version

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Eugen Minciu
+
+MIT License
+
+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,105 @@
+# Cliches: Easily set up attributes for your tests.
+
+## What is this?
+
+Cliches solves the endless problem of having to pass large hashes of 
+parameters to different methods in your tests. This is a problem that
+constantly appears when writing tests, a problem that people either 
+solve at the wrong level or don't solve at all.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cliches'
+
+And then run:
+
+    $ bundle
+
+## Why should I use this? 
+
+You may be thinking that fixtures of factories already solve this 
+problem. Well, they do, but only partly. Both of these solutions will 
+couple your attributes with ActiveRecord models, which really isn't 
+what you want. Consider these scenarios:
+
+1. You are writing an integration test. How can you easily get the
+attributes from a factory/fixture and just use them to do a POST?
+2. You want to use the attributes from one factory to update an 
+existing record. How do you do that without instantiating a record
+and potentially getting a lot of attributes you're not interested in.
+3. You have a method that takes a hash but has nothing to do with 
+ActiveRecord. You will be calling this method with very similar 
+arguments from many different tests. How do you keep these similar 
+attributes organized?
+
+
+## OK. What does this look like?
+
+cliches are defined in your test directory, in plain Ruby files that
+look like this:
+
+```ruby
+Cliches.define(:customer).as(
+  first_name: "Alice",
+  last_name: "Wilson",
+  state: "AL",
+  country: "US"
+)
+```
+
+That's it; easy-peasy. Their basic usage looks like this:
+
+```ruby
+Customer.create!(cliches(:customer))
+```
+
+Or like this to just instantiate:
+```
+Customer.new(cliches(:customer))
+```
+
+But you can also do this:
+```ruby
+customer.update_attributes(cliches(:customer))
+```
+
+And even this:
+```ruby
+post :create, {customer: cliches(:customer)}
+```
+
+
+## Rails Goodies
+There are a couple of things that the cliches gems provide to Rails
+developers to keep their syntax sugar-levels adequately high.
+ 
+There is a shortcut for building models:
+
+```ruby
+# This looks up cliches(:customer) and instantiates a model.
+Customer.cliche
+ 
+# This looks up cliches(:returning_customer) and instantiates a model
+Customer.cliche(:returning)
+
+# This does the same, but also saves the model
+Customer.cliche!(:returning)
+```
+
+The Rails integration also comes with a simple little generator that
+ you can use to create cliche files. Here's an example of how to run it:
+
+    $ bin/rails g cliches:new customer
+    
+This will generate a file called test/cliches/customer.rb and populate
+it with a simple example of how to use cliche.
+
+## Contributing
+
+1. Fork it ( https://github.com/thegengen/cliches/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'cane/rake_task'
+require 'rdoc/task'
+
+desc "Run the tests"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run cane to check quality metrics"
+Cane::RakeTask.new(:quality) do |cane|
+  cane.style_measure = 100
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "lib/cliches/*.rb")
+end
+
+task default: [:test, :quality]

data/cliches.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cliches/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cliches"
+  spec.version       = Cliches::VERSION
+  spec.authors       = ["Eugen Minciu"]
+  spec.email         = ["eugen@gengen.io"]
+  spec.summary       = "Easily set up attributes for your tests."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "cane", "~> 3.0"
+  spec.add_development_dependency "rdoc", "~> 4.0"
+  spec.add_development_dependency "rake"
+end

data/lib/cliches/active_record_extension.rb

@@ -0,0 +1,13 @@
+# :nodoc:
+module Cliches::ActiveRecordExtension
+  def cliche(name = nil)
+    full_name = [name, table_name.singularize].compact.join("_")
+    new(Cliches::Definition.find(full_name).value)
+  end
+
+  def cliche!(name = nil)
+    record = cliche(name)
+    record.save!
+    record
+  end
+end

data/lib/cliches/definition.rb

@@ -0,0 +1,46 @@
+# :nodoc:
+module Cliches
+  def self.define(name)
+    Definition.new(name).register
+  end
+
+  # A class that holds the basic definition of a cliche.
+  class Definition
+    attr_reader :name
+    attr_reader :value
+
+    # Initialize a cliche with the given +name+ and set its value to an empty hash.
+    #
+    # +name+ will be converted to a symbol
+    def initialize(name)
+      @name = name.to_sym
+      @value = {}
+    end
+
+    # Set the value of a definition as being +value+.
+    def as(value)
+      @value = value
+    end
+
+    # Finds the definition with a given +name+. Returns +nil+ if it there is none.
+    def self.find(name)
+      definitions[name.to_sym]
+    end
+
+    # Registers a definition. This will override any existing definition with the same name.
+    def register
+      self.class.definitions[name] = self
+      self
+    end
+
+    private
+
+    def self.definitions
+      @definitions ||= {}
+    end
+
+    def self.reset!
+      @definitions = {}
+    end
+  end
+end

data/lib/cliches/railtie.rb

@@ -0,0 +1,21 @@
+require 'rails'
+require 'rails/railtie'
+
+module Cliches
+  class Railtie < ::Rails::Railtie
+    config.cliches = ActiveSupport::OrderedOptions.new
+    config.cliches.directory = 'test/cliches'
+
+    initializer "cliches.load_files" do |app|
+      Dir[File.join(app.config.cliches.directory, '*.rb')].each {|file| load file }
+    end
+
+    initializer "cliches.extend_testcase" do
+      ActiveSupport::TestCase.include(Cliches::TestExtension)
+    end
+
+    initializer "cliches.extend_activerecord" do
+      ActiveRecord::Base.extend(Cliches::ActiveRecordExtension)
+    end
+  end
+end

data/lib/cliches/test_extension.rb

@@ -0,0 +1,6 @@
+# :nodoc:
+module Cliches::TestExtension
+  def cliches(name)
+    Cliches::Definition.find(name).value
+  end
+end

data/lib/cliches/version.rb

@@ -0,0 +1,3 @@
+module Cliches
+  VERSION = "0.0.1"
+end

data/lib/cliches.rb

@@ -0,0 +1,11 @@
+require "cliches/version"
+require "cliches/definition"
+
+if defined?(Rails)
+  require 'cliches/active_record_extension'
+  require 'cliches/test_extension'
+  require 'cliches/railtie'
+end
+
+module Cliches
+end

data/lib/generators/cliches/new_generator.rb

@@ -0,0 +1,15 @@
+require 'cliches/railtie'
+require 'rails'
+require 'rails/generators/base'
+
+# :nodoc:
+module Cliches
+  # :nodoc:
+  class NewGenerator < Rails::Generators::NamedBase
+    source_root File.join(File.dirname(__FILE__), "templates")
+
+    def create_cliche
+      template 'new_cliche.rb', File.join(Rails.configuration.cliches.directory, "#{file_name}.rb")
+    end
+  end
+end

data/lib/generators/cliches/templates/new_cliche.rb

@@ -0,0 +1,3 @@
+Cliches.define(:<%= file_name.singularize %>).as(
+  # TODO: Add attributes to this definition
+)

data/test/definition_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class DefinitionTest < Minitest::Test
+  def setup
+    Cliches::Definition.reset!
+  end
+
+  def test_new
+    d = Cliches::Definition.new(:test)
+
+    assert_equal :test, d.name
+    assert_equal Hash.new, d.value
+  end
+
+  def test_new_with_string
+    d = Cliches::Definition.new('test')
+
+    assert_equal :test, d.name
+  end
+
+  def test_as
+    d = Cliches::Definition.new(:test)
+    d.as(a: 3, b: 5)
+
+    assert_equal 3, d.value[:a]
+    assert_equal 5, d.value[:b]
+  end
+
+  def test_define
+    d = Cliches.define(:example)
+
+    assert_equal d, Cliches::Definition.find(:example)
+  end
+
+  def test_define_as
+    Cliches.define(:example).as(a: 3)
+
+    d = Cliches::Definition.find(:example)
+    assert_equal 3, d.value[:a]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'cliches'

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: cliches
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eugen Minciu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: cane
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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:
+- eugen@gengen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cliches.gemspec
+- lib/cliches.rb
+- lib/cliches/active_record_extension.rb
+- lib/cliches/definition.rb
+- lib/cliches/railtie.rb
+- lib/cliches/test_extension.rb
+- lib/cliches/version.rb
+- lib/generators/cliches/new_generator.rb
+- lib/generators/cliches/templates/new_cliche.rb
+- test/definition_test.rb
+- test/test_helper.rb
+homepage: ''
+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: Easily set up attributes for your tests.
+test_files:
+- test/definition_test.rb
+- test/test_helper.rb