generator_spec 0.0.1 → 0.0.2

data/README.md

@@ -23,4 +23,35 @@ Add 'generator_spec' to Gemfile and use just like you would test generators in t
       it "creates a test initializer" do
         assert_file "config/initializers/test.rb", "# Initializer"
       end
+    end
+    
+An RSpec file matching DSL is also provided, taken with permission from [beard](https://github.com/carlhuda/beard/blob/master/spec/support/matcher.rb) by [carlhuda](https://github.com/carlhuda).
+
+    describe TestGenerator, "using custom matcher" do
+      include GeneratorSpec::GeneratorExampleGroup
+
+      destination File.expand_path("../../tmp", __FILE__)
+      
+      before do
+        prepare_destination
+        run_generator
+      end
+
+      specify do
+        destination_root.should have_structure {
+          no_file "test.rb"
+          directory "config" do
+            directory "initializers" do
+              file "test.rb" do
+                contains "# Initializer"
+              end
+            end
+          end
+          directory "db" do
+            directory "migrate" do
+              file "123_create_tests.rb"
+            end
+          end
+        }
+      end
     end

data/lib/generator_spec/generator_example_group.rb

@@ -1,6 +1,7 @@
 require "rspec/rails"
 require "rails/generators/test_case"
 require "fileutils"
+require "generator_spec/matcher"
 
 # Adapted from Rails::Generators::TestCase
 # https://github.com/rails/rails/blob/master/railties/lib/rails/generators/test_case.rb
@@ -9,6 +10,7 @@ module GeneratorSpec
   module GeneratorExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
+    include Matcher
     include FileUtils
   
     included do

data/lib/generator_spec/matcher.rb

@@ -0,0 +1,108 @@
+module GeneratorSpec
+  module Matcher
+    # Author: Yahuda Katz
+    # Taken (with permission) from beard:
+    # https://github.com/carlhuda/beard
+  
+    class File
+      def initialize(name, &block)
+        @contents = []
+        @name = name
+
+        if block_given?
+          instance_eval(&block)
+        end
+      end
+
+      def contains(text)
+        @contents << text
+      end
+
+      def matches?(root)
+        unless root.join(@name).exist?
+          throw :failure, root.join(@name)
+        end
+
+        contents = ::File.read(root.join(@name))
+
+        @contents.each do |string|
+          unless contents.include?(string)
+            throw :failure, [root.join(@name), string, contents]
+          end
+        end
+      end
+    end
+
+    class Directory
+      attr_reader :tree
+
+      def initialize(root = nil, &block)
+        @tree = {}
+        @negative_tree = []
+        @root = root
+        instance_eval(&block) if block_given?
+      end
+
+      def directory(name, &block)
+        @tree[name] = block_given? && Directory.new(location(name), &block)
+      end
+
+      def file(name, &block)
+        @tree[name] = File.new(location(name), &block)
+      end
+
+      def no_file(name)
+        @negative_tree << name
+      end
+
+      def location(name)
+        [@root, name].compact.join("/")
+      end
+
+      def matches?(root)
+        @tree.each do |file, value|
+          unless value
+            unless root.join(location(file)).exist?
+              throw :failure, "#{root}/#{location(file)}"
+            end
+          else
+            value.matches?(root)
+          end
+        end
+
+        @negative_tree.each do |file|
+          if root.join(location(file)).exist?
+            throw :failure, [:not, "unexpected #{root}/#{location(file)}"]
+          end
+        end
+
+        nil
+      end
+    end
+
+    class Root < Directory
+      def failure_message
+        if @failure.is_a?(Array) && @failure[0] == :not
+          "Structure should not have had #{@failure[1]}, but it did"
+        elsif @failure.is_a?(Array)
+          "Structure should have #{@failure[0]} with #{@failure[1]}. It had:\n#{@failure[2]}"
+        else
+          "Structure should have #{@failure}, but it didn't"
+        end
+      end
+
+      def matches?(root)
+        root = Pathname.new(root) unless root.is_a?(Pathname)
+        @failure = catch :failure do
+          super
+        end
+
+        !@failure
+      end
+    end
+
+    def have_structure(&block)
+      Root.new(&block)
+    end
+  end
+end

data/lib/generator_spec/version.rb

@@ -1,3 +1,3 @@
 module GeneratorSpec
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/generator_spec/matcher_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe TestGenerator, "using custom matcher" do
+  include GeneratorSpec::GeneratorExampleGroup
+
+  destination File.expand_path("../../tmp", __FILE__)
+
+  before do
+    prepare_destination
+    run_generator
+  end
+  
+  specify do
+    destination_root.should have_structure {
+      no_file "test.rb"
+      directory "config" do
+        directory "initializers" do
+          file "test.rb" do
+            contains "# Initializer"
+          end
+        end
+      end
+      directory "db" do
+        directory "migrate" do
+          file "123_create_tests.rb"
+        end
+      end
+    }
+  end
+end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: generator_spec
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
-  version: 0.0.1
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Steve Hodgkiss
@@ -21,6 +26,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
         version: "3.0"
   type: :runtime
   version_requirements: *id001
@@ -32,6 +41,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -54,8 +66,10 @@ files:
 - generator_spec.gemspec
 - lib/generator_spec.rb
 - lib/generator_spec/generator_example_group.rb
+- lib/generator_spec/matcher.rb
 - lib/generator_spec/version.rb
 - spec/generator_spec/generator_example_group_spec.rb
+- spec/generator_spec/matcher_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_generator/templates/initializer.rb
 - spec/support/test_generator/templates/migration.rb
@@ -74,22 +88,29 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: generator_spec
-rubygems_version: 1.5.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Test Rails generators with RSpec
 test_files: 
 - spec/generator_spec/generator_example_group_spec.rb
+- spec/generator_spec/matcher_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_generator/templates/initializer.rb
 - spec/support/test_generator/templates/migration.rb