fun_with_gems 0.0.2 → 0.0.8

data/lib/fun_with/gems/testing/test_suite_runner.rb

@@ -0,0 +1,28 @@
+module FunWith
+  module Gems
+    module Testing
+      class TestSuiteRunner
+        attr_accessor :gem_const
+      
+        def initialize fwgem
+          self.gem_const = fwgem
+        end
+      
+        def passes_tests?
+          result = self.run_tests
+          result.passed?
+        end
+      
+        def run_tests
+          filepath = self.gem_const.root
+        
+          results = TestResults.new( self.gem_const )
+        
+          puts "running tests on #{self.gem_const} from #{filepath}"
+          results.output = `cd #{filepath} && rake test`
+          results
+        end
+      end
+    end
+  end
+end

data/lib/fun_with/gems/testing/validator.rb

@@ -0,0 +1,52 @@
+module FunWith
+  module Gems
+    module Testing
+      class Validator
+        def self.validate( gem_const )
+          self.new( gem_const ).validate
+        end
+      
+        def initialize( gem_const )
+          @gem_const = gem_const
+        end
+      
+        # should be available via the gem itgem_const?
+        def validate
+          @fun_gem_errors = []
+        
+          if @gem_const.respond_to?(:root)
+            if @gem_const.root.is_a?( FunWith::Files::FilePath )
+              @fun_gem_errors << ".root() doesn't exist"                unless @gem_const.root.directory?
+              @fun_gem_errors << "VERSION file doesn't exist"           unless @gem_const.root("VERSION").file?
+              @fun_gem_errors << "CHANGELOG.markdown doesn't exist"     unless @gem_const.root("CHANGELOG.markdown")
+              @fun_gem_errors << "lib directory doesn't exist"          unless @gem_const.root("lib").directory?
+            else
+              @fun_gem_errors << ".root() doesn't give a filepath"
+            end
+          else
+            @fun_gem_errors << "doesn't respond to .root()"
+          end
+        
+          if ! @gem_const.respond_to?(:version)
+            @fun_gem_errors << "doesn't respond to .version()"
+          end
+        
+          @fun_gem_errors
+        end
+      
+        def fun_gem_errors
+          @fun_gem_errors
+        end
+      
+        def git_up_to_date?( filepath )
+          # On branch master
+          #         Your branch is ahead of 'origin/master' by 1 commit.
+          #           (use "git push" to publish your local commits)
+          # 
+          #         nothing to commit, working directory clean
+          #         
+        end
+      end
+    end
+  end
+end

data/lib/fun_with/gems/versionizer.rb

@@ -0,0 +1,41 @@
+module FunWith
+  module Gems
+    class Versionizer
+      TRAILING_VERSION_STRING_MATCHER = /(?<=-)(\d|\.)+$/
+      
+      def self.versionize( *args )
+        self.new.versionize( *args )
+      end
+      
+      def versionize( gem_const, version_string = nil )
+        version_string = infer_version_string_for_gem( gem_const )
+        FunWith::VersionStrings.versionize( gem_const, version_string ) if version_string.fwf_present?
+      end
+      
+      protected
+      def infer_version_string_for_gem( gem_const, version_string = nil )
+        version_string || version_string_from_gem_version_file( gem_const ) || version_string_from_gem_folder( gem_const )
+      end
+      
+      def version_string_from_gem_version_file( gem_const )
+        if gem_const.respond_to?(:root) 
+          vfile = gem_const.root( "VERSION" )
+          (vfile.file? && vfile.readable?) ? vfile.read : nil
+        else
+          nil
+        end
+      end
+      
+      # most gems get installed into a rubygems folder under the folder name <gem_name>-X.XX.X
+      def version_string_from_gem_folder( gem_const )
+        if gem_const.respond_to?(:root)
+          if m = gem_const.root.path.match( TRAILING_VERSION_STRING_MATCHER )
+            return m[0]
+          end
+        end
+        
+        return nil
+      end
+    end
+  end
+end

data/lib/fun_with_gems.rb

@@ -1,20 +1,21 @@
 require "fun_with_version_strings"
 require "fun_with_files"
 
-# FunWith::VersionStrings.versionize( FunWith::Files )
-
 lib_dir = __FILE__.fwf_filepath.dirname
-lib_dir.join( "fun_with", "gems", "gem_api.rb" ).requir
-lib_dir.join( "fun_with", "gems", "fun_gem_api.rb" ).requir
-# 
-# require File.join( File.dirname( __FILE__ ), "fun_with", "gems", "gem_api" )
-# require File.join( File.dirname( __FILE__ ), "fun_with", "gems", "fun_gem_api" )
+lib_dir.join( "fun_with", "gems" ).requir
+# lib_dir.join( "fun_with", "gems", "fun_gem_api.rb" ).requir
+
+FunWith::Gems.extend( FunWith::Gems::GemAPI )  # For most FunGems, this would happen automatically.
+
+# Skip the things FunWith::Files does for itself
+FunWith::Gems.make_gem_fun( FunWith::Files, 
+                            require: false, 
+                            set_root: false,
+                            set_version: false  #,
+#                            configuration: false
+                          )
+
 
-FunWith::Gems.extend( FunWith::Gems::GemAPI )
+FunWith::Gems.make_gem_fun( FunWith::Gems )
 
-# versionizes
-# rootifies
-# requir's the lib/fun_with directory
-# Do this because FunWithFiles doesn't do it itself.  
-FunWith::Gems.make_gem_fun( FunWith::Files, :require => false, :set_root => false, :set_version => false )
-FunWith::Gems.make_gem_fun( "FunWith::Gems" )
+# Module.send( :include, FunWith::Gems::CoreExtensions::Module )    # happens automatically

data/lib/tasks/fun_with/gems/publish.rake

@@ -0,0 +1,8 @@
+namespace :fun_with do
+  namespace :gems do
+    desc "Publish your gem to the world."
+    task :publish => :validate do
+      puts "Pretending to publish."
+    end
+  end
+end

data/lib/tasks/fun_with/gems/validate.rake

@@ -0,0 +1,28 @@
+namespace :fun_with do
+  namespace :gems do
+    desc "Validate your gem (passes tests, has FunWith::Gems functionality)."
+    task :validate do
+      g = FunWith::Gems::Rakefile.get_gem
+    
+      if g.is_fun_gem?
+        if g.valid_gem?
+          puts "#{g} passed validation."
+          
+          if g.passes_tests?
+            puts "#{g} passed its test suite"
+            true
+          else
+            puts "#{g} failed its test suite"
+            false
+          end
+        else
+          puts "#{g} failed validation"
+          false
+        end
+      else
+        puts "#{g} is not a FunWith::Gems gem."
+        false
+      end
+    end
+  end
+end

data/tasks/empty/empty.rake

@@ -0,0 +1,6 @@
+namespace :empty do
+  desc "Fake task"
+  task( :empty  => :environment ) do
+    puts "Fake task!"
+  end
+end

data/tasks/empty/environment.rake

@@ -0,0 +1,7 @@
+namespace :empty do
+  desc "Fake task"
+  
+  task :environment do
+    require File.join( File.dirname(__FILE__), "..", "..", "lib", "fun_with_gems" )
+  end
+end

data/test/assertions.rb

@@ -0,0 +1,15 @@
+
+module FunWith
+  module Gems
+    module Testing
+      # This is where you put custom assertions that only need to be available to the gem's test suite.
+      # To make an assertion available to a gem that uses this gem as a dependency, put it in
+      # <GEM_ROOT>/lib/<GEM>/testing/assertions.rb
+      module Assertions
+        def assert_example_assertion
+          assert true
+        end
+      end
+    end
+  end
+end

data/test/data/test_gems/array_inherits_enumerable/VERSION

@@ -0,0 +1 @@
+0.0.0

data/test/data/test_gems/array_inherits_enumerable/lib/array_inherits_enumerable/core_extensions/comparable.rb

@@ -0,0 +1,9 @@
+module ArrayInheritsEnumerable
+  module CoreExtensions
+    module Comparable
+      def string_should_have_this_method(*args)
+        return :it_does
+      end
+    end
+  end
+end

data/test/data/test_gems/array_inherits_enumerable/lib/array_inherits_enumerable/core_extensions/enumerable.rb

@@ -0,0 +1,10 @@
+module ArrayInheritsEnumerable
+  module CoreExtensions
+    module Enumerable
+      def array_should_have_this_method(*args)
+        puts args.inspect
+      end
+    end
+  end
+end
+      

data/test/data/test_gems/array_inherits_enumerable/lib/array_inherits_enumerable/core_extensions/numeric.rb

@@ -0,0 +1,22 @@
+# This example uses the inclusionize system
+module ArrayInheritsEnumerable
+  module CoreExtensions
+    module Numeric
+      module Constants
+        COUNTLESS = Float::INFINITY
+      end
+      
+      module ClassMethods
+        def give_me_a_random_number
+          :no
+        end
+      end
+      
+      module InstanceMethods
+        def prime?
+          :maybe
+        end
+      end
+    end
+  end
+end

data/test/data/test_gems/array_inherits_enumerable/lib/array_inherits_enumerable.rb

@@ -0,0 +1 @@
+FunWith::Gems.make_gem_fun( "ArrayInheritsEnumerable" )

data/test/data/test_gems/fun_with_llamas/lib/fun_with/llamas/gem_api.rb

@@ -0,0 +1,10 @@
+module FunWith
+  module Llamas
+    # Should be automagically 
+    module GemAPI
+      def can_make_the_llamas_dance?
+        true
+      end
+    end
+  end
+end

data/test/data/test_gems/fun_with_llamas/lib/fun_with/llamas/llama.rb

@@ -0,0 +1,40 @@
+module FunWith
+  module Llamas
+    class Llama
+      attr_accessor :name
+      
+      def initialize( name )
+        @name = name
+        @regards = {}
+      end
+      
+      def scorns( trainer )
+        remember_trainer( trainer )
+        @regards[ trainer.name ] -= 1
+      end
+      
+      # Ptooi!
+      def spit( trainer )
+        remember_trainer( trainer )
+        @regards[ trainer.name ] -= 1
+      end
+
+      def brushed_by( trainer )
+        remember_trainer( trainer )
+        @regards[ trainer.name ] += 1
+      end
+      
+      def remember_trainer( trainer )
+        @regards[ trainer.name ] ||= 0
+      end
+      
+      def knows?( trainer )
+        @regards.has_key?( trainer.name )
+      end
+      
+      def trainer_score( trainer )
+        @regards[ trainer.name ]
+      end
+    end
+  end
+end

data/test/data/test_gems/fun_with_llamas/lib/fun_with/llamas/trainer.rb

@@ -0,0 +1,15 @@
+module FunWith
+  module Llamas
+    class Trainer
+      attr_accessor :name
+      
+      def initialize( name )
+        @name = name
+      end
+      
+      def brush( llama )
+        llama.brushed_by( self )
+      end
+    end
+  end
+end

data/test/data/test_gems/integer_magic/VERSION

@@ -0,0 +1 @@
+3.1.4

data/test/data/test_gems/integer_magic/config/gem_config.rb

@@ -0,0 +1,4 @@
+integer_magic_level 5
+debug_level         9
+an_empty_hash       {}
+an_array_of_zeros   [0,0,0,0,0.000]

data/test/data/test_gems/integer_magic/lib/integer_magic/core_extensions/integer.rb

@@ -0,0 +1,28 @@
+module IntegerMagic
+  module CoreExtensions
+    module Integer       # the CoreClassName
+      include FunWith::Gems::Inclusionizer
+
+      module Constants
+        ZERO = 0
+        HIGHEST_PRIME_NUMBER = 9
+      end
+
+      module ClassMethods
+        def thinking_of_a_number_between_zero_and( n )
+          return :you_guessed_correctly
+        end
+      end
+
+      module InstanceMethods
+        def even?
+          self % 2 == 0
+        end
+
+        def odd?
+          self % 2 == 1
+        end
+      end
+    end
+  end
+end

data/test/data/test_gems/integer_magic/lib/integer_magic/core_extensions/numeric.rb

@@ -0,0 +1,13 @@
+module IntegerMagic
+  module CoreExtensions
+
+    # uses the simpler module definition (none of the ::ClassMethods / ::InstanceMethods submodule nonsense)
+    # but still gets included properly
+    module Numeric
+      def integer?
+        self.is_a?( Integer )
+      end
+    end
+  end
+end
+

data/test/data/test_gems/integer_magic/lib/integer_magic.rb

@@ -0,0 +1 @@
+FunWith::Gems.make_gem_fun( "IntegerMagic" )

data/test/helper.rb

@@ -1,45 +1,16 @@
 require 'fun_with_testing'
-
-# require 'simplecov'
-# 
-# module SimpleCov::Configuration
-#   def clean_filters
-#     @filters = []
-#   end
-# end
-# 
-# SimpleCov.configure do
-#   clean_filters
-#   load_adapter 'test_frameworks'
-# end
-# 
-# ENV["COVERAGE"] && SimpleCov.start do
-#   add_filter "/.rvm/"
-# end
-
-# require 'rubygems'
-# require 'bundler'
-
-# begin
-#   Bundler.setup(:default, :development)
-# rescue Bundler::BundlerError => e
-#   $stderr.puts e.message
-#   $stderr.puts "Run `bundle install` to install missing gems"
-#   exit e.status_code
-# end
-# require 'test/unit'
-# require 'shoulda'
-
-# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-# $LOAD_PATH.unshift(File.dirname(__FILE__))
-
 require 'fun_with_gems'
 
-FunWith::Gems.make_gem_fun( FunWith::Testing, :require => false )
+unless defined?(FunWith::Gems)
+  puts "FunWith::Gems not defined"
+end
 
-# class Test::Unit::TestCase
-# end
+# I don't recall why this was needed
+FunWith::Gems.make_gem_fun( FunWith::Testing, :require => false )
 
 class FunWith::Gems::TestCase < FunWith::Testing::TestCase
-  include FunWith::Testing::Assertions::Basics
+  # include: true option means that, within the test suite, the gem's namespace
+  # is included, so classes within that namespace can be referenced without using
+  # the namespace.
+  self.make_testing_fun( FunWith::Gems, include: true )
 end

data/test/test_core_extensions.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+class TestCoreExtensions < FunWith::Gems::TestCase
+  context "testing core extensions" do
+    should "have this test under core extensions" do
+      assert_respond_to( Module.new, :is_fun_gem? )
+      assert_false( Module.new.is_fun_gem? )
+    end
+  end
+end

data/test/test_fun_with_gems.rb

@@ -10,6 +10,12 @@ class TestFunWithGems < FunWith::Gems::TestCase
     
     should "be a proper gem" do
       assert_respond_to( FunWith::Gems, :version )
+      assert_respond_to( FunWith::Gems, :is_fun_gem? )
+      assert( FunWith::Gems.is_fun_gem? )
+    end
+    
+    should "be a proper gem (using the assertion method provided by Testing::Assertions)" do
+      assert_fun_gem( FunWith::Gems )
     end
     
     should "respond to API methods" do
@@ -31,26 +37,13 @@ class TestFunWithGems < FunWith::Gems::TestCase
     should "respond to fwf_...() methods" do
       assert_respond_to( "", :fwf_blank? )
       assert_respond_to( "", :fwf_present? )
+      
+      assert_respond_to( Set.new, :fwf_blank? )
+      assert_respond_to( Set.new, :fwf_present? )
     end
     
     should "validate self" do
       assert FunWith::Gems.valid_gem?
     end
   end
-  
-  context "testing gem loading" do
-    should "load llama gem" do
-      FunWith::Gems.root( "test", "test_gem", "lib", "fun_with_llamas.rb" ).requir
-    
-      assert defined?( FunWith )
-      assert defined?( FunWith::Llamas )
-      assert defined?( FunWith::Llamas::Llama )
-      assert defined?( FunWith::Llamas::Trainer )
-      assert_respond_to( FunWith::Llamas::Llama.new, :spit )
-    
-      assert_equal 3, FunWith::Llamas.version.major
-      
-      assert FunWith::Llamas.valid_gem?
-    end
-  end
 end

data/test/test_library_requirer.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class TestLibraryRequirer < FunWith::Gems::TestCase
+  context "testing guess_caller_file()" do
+    should "meet expectations" do
+      lb = LibraryRequirer.new
+      
+      assert_equal "hello_there/world.rb", lb.constant_name_to_filename( "HelloThere::World" )
+      assert_equal "swing_set/api_manager.rb", lb.constant_name_to_filename( "SwingSet::APIManager" )
+      assert_equal "tasks.rb", lb.constant_name_to_filename( "Tasks" )
+    end
+  end
+end

data/test/test_the_test_case.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestTheTestCase < FunWith::Gems::TestCase
+  context "putting a test case through its paces" do
+    should "have GemToTest methods installed" do
+      assert_respond_to self, :gem_to_test
+      assert_respond_to self.class, :gem_to_test
+    end
+    
+    should "have external fun_gem assertions installed" do
+      assert_respond_to self, :assert_gem_is_fine
+      assert_respond_to self, :assert_fun_gem
+    end
+    
+    should "know which gem is being tested" do
+      assert_equal FunWith::Gems, self.gem_to_test
+      assert_equal FunWith::Gems, self.class.gem_to_test
+    end
+    
+    should "have assertions from test/assertions.rb available within this test suite" do
+      assert_respond_to self, :assert_example_assertion
+    end
+  end
+end