cpb-generators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ba26f6029d31aca25618826901c9ab020f141db
+  data.tar.gz: 6f2f126251b3228bdbbe72cc4ef5b357a367c1cd
+SHA512:
+  metadata.gz: ff877cbe9d783993329f140474893bfc00d99a2d0069109da0bd8f845a40e7161d384c58d01cc349ff8eabda3c7f6852887962bde507efeba86c0ed257da0348
+  data.tar.gz: 21607da2b95383f369e1fc4990f8cc4e8e6e53ff9dcbe3e95d80c2a490184b2b2dd380d3de19732622854acc326bcd4012aed6faea766354f2035d52048f49f1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cpb-generators.gemspec
+gemspec
+
+group :development do
+  gem "aruba", github: 'cpb/aruba', branch: 'reporting_argument_error'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Caleb Buxton
+
+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,38 @@
+# Cpb::Generators
+
+My idiomatic Ruby practices, encoded.
+Includes generators for common workflow patterns.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    group :development do
+      gem 'cpb-generators'
+    end
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+    $ bundle exec cpb entity namespace/class_name
+        create  lib/namespace/class_name.rb
+        create  spec/namespace/class_name_spec.rb
+
+    $ bundle exec rspec spec/namespace/class_name_spec.rb
+    *
+
+    Pending:
+      Namespace::ClassName Define what Namespace::ClassName does
+        # No reason given
+        # ./spec/namespace/class_name_spec.rb:6
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+Cucumber::Rake::Task.new(:run_aruba_features, nil) do |t|
+  t.cucumber_opts = "ARUBA_REPORT_DIR=doc --format progress"
+end
+
+task :check_for_pygments do
+  unless system("pygmentize", [:err,:out]=>"/dev/null")
+    raise "You're missing pygmentize, try:\n sudo easy_install Pygments"
+  end
+end
+
+desc "Run Cucumber features generating Aruba Report using Pygments"
+task :aruba_features => [:check_for_pygments, :run_aruba_features]
+task :default => [:spec,:features]

data/bin/cpb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'cpb/generators'
+
+Cpb::Generators::Runner.start

data/cpb-generators.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cpb/generators/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cpb-generators"
+  spec.version       = Cpb::Generators::VERSION
+  spec.authors       = ["Caleb Buxton"]
+  spec.email         = ["me@cpb.ca"]
+  spec.description   = %q{My idiomatic Ruby practices, encoded}
+  spec.summary       = %q{Includes generators for common workflow patterns}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "thor"
+  spec.add_dependency "rspec"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+end

data/features/readme.feature

@@ -0,0 +1,25 @@
+Feature: I can install cpb-generators and generate files
+
+  @disable-bundler
+  Scenario: Installation in the development group
+    Given a file named "Gemfile" with:
+    """
+    group :development do
+      gem 'cpb-generators', path: '../..'
+    end
+    """
+    And I run `bundle install`
+    When I run `bundle exec cpb entity namespace/new_name`
+    Then a file named "lib/namespace/new_name.rb" should exist
+    And a file named "spec/namespace/new_name_spec.rb" should exist
+
+  Scenario: Usage post installation
+    Given a Gemfile setup with:
+    """
+    group :development do
+      gem 'cpb-generators', path: '../..'
+    end
+    """
+    And I run `bundle exec cpb entity namespace/class_name`
+    When I run `bundle exec rspec`
+    Then the output should contain "pending"

data/features/step_definitions/readme_steps.rb

@@ -0,0 +1,5 @@
+Given(/^a Gemfile setup with:$/) do |file_content|
+  unset_bundler_env_vars
+  write_file("Gemfile", file_content)
+  run_simple(unescape("bundle install"), false)
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/cpb/generators/class_generator/spec.rb.tt

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+require '<%= class_path(name) %>'
+
+describe <%= described_class(name) %> do
+  pending "Define what #{described_class} does"
+end

data/lib/cpb/generators/class_generator.rb

@@ -0,0 +1,67 @@
+require 'thor/group'
+
+module Cpb
+  module Generators
+    class ClassGenerator < Thor::Group
+      include Thor::Actions
+
+      argument :name
+
+      source_root File.expand_path("class_generator",File.dirname(__FILE__))
+      def create_class
+        create_file "lib/#{class_path(name)}.rb" do
+          verbose_namespace_definition(name)
+        end
+      end
+
+      def create_spec
+        template "spec.rb.tt", "spec/#{class_path(name)}_spec.rb"
+      end
+
+      def create_spec_helper
+        create_file "spec/spec_helper.rb" do
+          "$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)"
+        end
+      end
+
+      private
+      def class_path(name)
+        @class_path ||= if name =~ /[A-Z]/
+          name.gsub(/::/, '/').
+          gsub!(/(.)([A-Z])/,'\1_\2').
+          downcase
+        else
+          name
+        end
+      end
+
+      def described_class(name)
+        @described_class ||= name.split(/[\/-]/).map do |frag|
+          frag.split('_').map(&:capitalize).join("")
+        end.join("::")
+      end
+
+      def verbose_namespace_definition(name)
+        first_part, parts = described_class(name).split("::").reverse
+
+        if parts
+          parts = Array(parts)
+          i = parts.length
+          parts.inject(lambda { "#{tabs(parts.length)}class #{first_part}\n#{tabs(parts.length)}end\n" }) do |memo, namespace|
+            lambda do
+              "#{tabs(i-=1)}module #{namespace}\n" +
+                memo.call +
+              "#{tabs(i)}end\n"
+            end
+          end.call
+        else
+          "class #{first_part}\nend"
+        end
+      end
+
+      def tabs(i)
+        "  "*i
+      end
+    end
+  end
+end

data/lib/cpb/generators/version.rb

@@ -0,0 +1,5 @@
+module Cpb
+  module Generators
+    VERSION = "0.1.0"
+  end
+end

data/lib/cpb/generators.rb

@@ -0,0 +1,12 @@
+require "cpb/generators/version"
+require "thor"
+
+require 'cpb/generators/class_generator'
+
+module Cpb
+  module Generators
+    class Runner < Thor
+      register Cpb::Generators::ClassGenerator, "entity", "entity [class_name]", "Generates a class and spec"
+    end
+  end
+end

data/spec/cpb/generators/class_generator_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+require 'cpb/generators/class_generator'
+
+describe Cpb::Generators::ClassGenerator do
+  destination File.expand_path("../../../../tmp/class_artifacts",__FILE__)
+
+  before { prepare_destination }
+
+  it 'runs both the class and spec tasks' do
+    gen = generator %w(posts)
+    gen.should_receive :create_class
+    gen.should_receive :create_spec
+    capture(:stdout) { gen.invoke_all }
+  end
+
+  describe 'the generated files' do
+    before do
+      run_generator %w(posts)
+    end
+
+    describe 'the spec' do
+      subject { file('spec/posts_spec.rb') }
+
+      it { should exist }
+      it { should contain(/require 'spec_helper'/) }
+      it { should contain(/describe Posts/) }
+    end
+
+    describe 'the implementation' do
+      subject { file('lib/posts.rb') }
+
+      it { should exist }
+      it { should contain(/class Posts/) }
+    end
+  end
+end
+

data/spec/cpb/generators_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Cpb::Generators do
+  it 'should have a version number' do
+    Cpb::Generators::VERSION.should_not be_nil
+  end
+end

data/spec/matchers/contain.rb

@@ -0,0 +1,19 @@
+RSpec::Matchers.define :contain do |expected_content|
+  match do |file_path|
+    @actual_contents = File.new(file_path).read
+    case expected_content
+    when String
+      @actual_contents.include? expected_content
+    when Regexp
+      @actual_contents =~ expected_content
+    end
+  end
+
+  failure_message_for_should do |file_path|
+    "expected the file #{file_path} to contain #{expected_content.inspect} but it contained #{@actual_contents.inspect}"
+  end
+
+  failure_message_for_should_not do |file_path|
+    "expected the file #{file_path} to not contain #{expected_content.inspect} but it did"
+  end
+end

data/spec/matchers/exist.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :exist do
+  match do |file_path|
+    File.exists?(file_path)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'cpb/generators'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/matchers/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.extend(Helpers::ClassMethods)
+  config.include(Helpers::InstanceMethods)
+end

data/spec/support/helpers.rb

@@ -0,0 +1,43 @@
+module Helpers
+
+  module ClassMethods
+    def destination(new_destination)
+      let(:destination_root) { new_destination }
+    end
+  end
+
+  module InstanceMethods
+    def capture(stream,&block)
+      capturing = StringIO.new
+
+      case stream
+      when :stdout
+        $stdout = capturing
+      end
+
+      yield
+      capturing
+    ensure
+      $stdout = STDOUT
+    end
+
+    def prepare_destination
+      FileUtils.rm_rf destination_root
+      FileUtils.mkdir_p destination_root
+    end
+
+    def generator(arguments, options={}, config={})
+      @generator ||= described_class.new(arguments, options, {destination_root: destination_root}.merge(config))
+    end
+
+    def run_generator(arguments, options={}, config={})
+      capture(:stdout) {
+        generator(arguments,options,config).invoke_all
+      }
+    end
+
+    def file(relative)
+      File.expand_path(relative, destination_root)
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: cpb-generators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caleb Buxton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: rspec
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: My idiomatic Ruby practices, encoded
+email:
+- me@cpb.ca
+executables:
+- cpb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cpb
+- cpb-generators.gemspec
+- features/readme.feature
+- features/step_definitions/readme_steps.rb
+- features/support/env.rb
+- lib/cpb/generators.rb
+- lib/cpb/generators/class_generator.rb
+- lib/cpb/generators/class_generator/spec.rb.tt
+- lib/cpb/generators/version.rb
+- spec/cpb/generators/class_generator_spec.rb
+- spec/cpb/generators_spec.rb
+- spec/matchers/contain.rb
+- spec/matchers/exist.rb
+- spec/spec_helper.rb
+- spec/support/helpers.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.0.3
+signing_key: 
+specification_version: 4
+summary: Includes generators for common workflow patterns
+test_files:
+- features/readme.feature
+- features/step_definitions/readme_steps.rb
+- features/support/env.rb
+- spec/cpb/generators/class_generator_spec.rb
+- spec/cpb/generators_spec.rb
+- spec/matchers/contain.rb
+- spec/matchers/exist.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb