fun_with_gems 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzVhMzg5YmQzMGQ0ZDM0ZDU4NTcxYzBmYmMwZGE0NzE4NDgzNWI5Zg==
+  data.tar.gz: !binary |-
+    OTFjZWM4Njg3ZDlmYjRjMDg2NDI0YTA5MWE3NTg2ODA5Y2Y1NWVlNw==
+SHA512:
+  metadata.gz: !binary |-
+    NDgzYTk3NmU0YjE3ZjA5MWZhZjZmMWNmNjNiZjdmZGUyOGYyZGQ2N2MyNDZm
+    OWNmM2E0NGRjMTY4NzBjOTA0MmE1NzQwODkyZDFlZGZkMWU4NjAyOGI2MjQ2
+    ZDBmNWU0MGEyZTk0OTBjMGMwMjQxYjNhYjRhOWJkMWVhNjBkMGU=
+  data.tar.gz: !binary |-
+    ZmI0NzA0YzY0MDgzM2QyODE0NTc3YThjYjVhZGFhYTZiYzI0OTJjYTg4YjY2
+    MTViYjRhNjg4OWU5YzVjNDM2MGM3YTNhN2NkNGJkYjY0MzNiMjZhZWQwYTk0
+    OWExODRkZGQ1MjhhMzk3ZGIyYWZlZGMwZmJkNGVjYTk4MzQ3Y2Y=

data/CHANGELOG.markdown

@@ -0,0 +1,10 @@
+0.0.1
+-----
+
+
+
+
+0.0.0
+-----
+
+No changes!

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", "~> 3.5"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0"
+  gem "simplecov", "~> 0", ">= 0.8"
+
+  # Should be safe to add.  By default, none of the assert functions get added to Test::Unit::TestCase
+  gem "fun_with_testing", "~> 0.0"
+end
+
+gem "fun_with_files", "~> 0.0", ">= 0.0.7"
+gem "fun_with_version_strings", "~> 0.0", ">= 0.0.3"
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Bryce Anderson
+
+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.rdoc

@@ -0,0 +1,19 @@
+= fun_with_gems
+
+Description goes here.
+
+== Contributing to fun_with_gems
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Bryce Anderson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "fun_with_gems"
+  gem.homepage = "http://github.com/darthschmoo/fun_with_gems"
+  gem.license = "MIT"
+  gem.summary = "Dependency for most of my FunWith:: gems.  Not much use standalone."
+  gem.description = "Dependency for FunWith gems, simplifies the setup of new gems, installing version data, root filepath, and default requirements."
+  gem.email = "keeputahweird@gmail.com"
+  gem.authors = ["Bryce Anderson"]
+  # dependencies defined in Gemfile
+  
+  gem.files = Dir.glob( File.join( ".", "lib", "**", "*.rb" ) ) + 
+              Dir.glob( File.join( ".", "test", "**", "*" ) ) +
+              %w( Gemfile Rakefile LICENSE.txt README.rdoc VERSION CHANGELOG.markdown )  
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fun_with_gems #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/fun_with/gems/core_extensions/module.rb

@@ -0,0 +1,5 @@
+class Module
+  def is_fun_gem?
+    false
+  end
+end

data/lib/fun_with/gems/fun_gem_api.rb

@@ -0,0 +1,38 @@
+module FunWith
+  module Gems
+    module FunGemAPI
+      def is_fun_gem?
+        true
+      end
+      
+      def validate_gem
+        FunWith::Gems::Validator.new(self).validate
+      end
+      
+      def valid_gem?
+        self.validate_gem.fwf_blank?
+      end
+      
+      def gem_test_mode?
+        @fwg_gem_test_mode || false
+      end
+      
+      # I can't think of a compelling reason to go beyond true/false here
+      def gem_test_mode=( mode )
+        @fwg_gem_test_mode = mode
+      end
+      
+      def gem_verbose?
+        @fwg_gem_verbose || false      # rather return false than nil
+      end
+      
+      def gem_verbose=( mode )
+        @fwg_gem_verbose = mode
+      end
+        
+      def say_if_verbose( msg, stream = $stdout )
+        stream.puts( msg ) if gem_verbose?
+      end
+    end
+  end
+end

data/lib/fun_with/gems/gem_api.rb

@@ -0,0 +1,84 @@
+module FunWith
+  module Gems
+    module GemAPI
+      # Very opinionated.  Expects the function to be called in the gem's lib/gem_name.rb file.
+      # Also expects a VERSION file at the root of the gem, which has "0.0.3" (or whatever), and 
+      # nothing else.  Finally, it expects that 'requiring' the classes the gem needs is a simple
+      # matter of requiring every item in the lib/fun_with directory, so keep those classes clean.
+      # The string given should represent the module that refers to the gem as a whole.
+      # 
+      # Configurable options:
+      # While all these things are handled by default, some things can be overridden
+      # :main_lib_file => use a different filepath to calculate the root
+      #
+      # :root => or render :main_lib_file moot by declaring a different root.
+      # 
+      # :version => Declare a different version string for the gem.
+      # 
+      # :require => false (avoids requiring the default lib/fun_with dir.)
+      # :require => filepath or array of filepaths   (require these things instead (note: not in addition to))
+      def make_gem_fun( gem_const, opts = {} )
+        @caller_file = caller.first.gsub(/:\d+:.*/,'')
+        @opts = opts
+        set_gem_const( gem_const )
+        @gem_const.extend( FunGemAPI )
+        set_gem_root
+        set_gem_version
+        require_libs
+      end
+      
+      protected
+      def set_gem_const( gem_const )
+        # Create new modules for this fun, fun gem, if necessary.
+        if gem_const.is_a?( String )
+          #create the module
+          const = Object
+          full_const_name = ""
+          gem_const.split("::").each do |module_name|
+            full_const_name << "::" unless full_const_name.fwf_blank?
+            full_const_name << module_name
+            
+            if eval( "defined?(#{full_const_name})")
+              const = eval( full_const_name )
+            else
+              const = const.const_set( module_name, Module.new )
+            end
+          end
+        
+          @gem_const = eval( gem_const )
+        else
+          @gem_const = gem_const
+        end
+      end
+      
+      def set_gem_root
+        return if @opts[:set_root] == false
+        
+        # Hence, the "make_gem_fun()" directive should be called in the lib/gem_name.rb file.
+        main_lib_file = @opts[:main_lib_file] || @caller_file
+        root = @opts[:root] || main_lib_file.fwf_filepath.expand.dirname.up
+        
+        Files::RootPath.rootify( @gem_const, root )
+      end
+
+      def set_gem_version
+        return if @opts[:set_version] == false
+        if @opts[:version]
+          VersionStrings.versionize( @gem_const, @opts[:version] )
+        else
+          VersionStrings.versionize( @gem_const )
+        end
+      end
+      def require_libs
+        unless @opts[:require] == false
+          @opts[:require] ||= [ @gem_const.root( "lib", "fun_with" ) ]
+          @opts[:require] = [ @opts[:require] ] unless @opts[:require].is_a?(Array)
+        
+          @opts[:require].each do |req_dir|
+            req_dir.fwf_filepath.expand.requir
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fun_with/gems/mechanic.rb

@@ -0,0 +1,27 @@
+module FunWith
+  module Gems
+    
+    class Mechanic
+      def bump_version( gem_const )
+        if Validator.new.validate( gem_const )
+        # if tests pass and gem is valid
+        
+          # run rake version:bump:patch
+        
+          # git commit
+        
+          # git push
+        
+          # add branch v<VERSION>
+        
+          # rake install
+        
+          # gem push
+        
+        else
+          puts "Failed"
+        end
+      end
+    end
+  end
+end

data/lib/fun_with/gems/validator.rb

@@ -0,0 +1,69 @@
+module FunWith
+  module Gems
+    class Validator
+      TEST_SUITE_DATA_REGEX = /(<?tests>\d+) tests, (<?assertions>\d+) assertions, (<?failures>\d+) failures, (<?errors>\d+) errors, (<?skips>\d+) skips/
+
+      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/fun_with directory doesn't exist" unless @gem_const.root("lib", "fun_with").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)
+          
+        else
+          @fun_gem_errors << "doesn't respond to .version()"
+        end
+        
+        @fun_gem_errors
+      end
+      
+      def fun_gem_errors
+        @fun_gem_errors
+      end
+      
+      
+      def passes_tests?( filepath )
+        @test_output = `cd #{filepath} && rake`
+        results = scan_results( @test_output )
+      end
+      
+      def scan_results( str )
+        if m = str.match( TEST_SUITE_DATA_REGEX )
+          m[0]
+        else
+          "TEST STATS NOT FOUND"
+        end
+      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

data/lib/fun_with_gems.rb

@@ -0,0 +1,20 @@
+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" )
+
+FunWith::Gems.extend( FunWith::Gems::GemAPI )
+
+# 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" )

data/test/helper.rb

@@ -0,0 +1,42 @@
+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_testing'
+require 'fun_with_gems'
+
+FunWith::Gems.make_gem_fun( FunWith::Testing, :require => false )
+
+class Test::Unit::TestCase
+end
+
+class FunWith::Gems::TestCase < FunWith::Testing::TestCase
+  include FunWith::Testing::Assertions::Basics
+end

data/test/test_fun_with_gems.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class TestFunWithGems < FunWith::Gems::TestCase
+  context "checking the plumbing" do
+    should "have FunWith::Gems constants defined" do
+      assert defined?( FunWith )
+      assert defined?( FunWith::Gems )
+      assert defined?( FunWith::Gems::GemAPI )
+    end
+    
+    should "respond to API methods" do
+      assert_respond_to( FunWith::Gems, :root )
+      assert_respond_to( FunWith::Gems, :version )
+      assert_respond_to( FunWith::Gems, :make_gem_fun )
+    end
+    
+    should "have FunWith::Files constants" do
+      assert defined?( FunWith::Files )
+      assert defined?( FunWith::Files::FilePath )
+      assert defined?( FunWith::Files::RootPath )
+      assert defined?( FunWith::Files::DirectoryBuilder )
+    end
+    
+    should "respond to fwf_...() methods" do
+      assert_respond_to( "", :fwf_blank? )
+      assert_respond_to( "", :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_gem/VERSION

@@ -0,0 +1 @@
+3.5.2

data/test/test_gem/lib/fun_with/llamas/llama.rb

@@ -0,0 +1,9 @@
+module FunWith
+  module Llamas
+    class Llama
+      def spit
+        puts "ptooi!"
+      end
+    end
+  end
+end

data/test/test_gem/lib/fun_with/llamas/trainer.rb

@@ -0,0 +1,9 @@
+module FunWith
+  module Llamas
+    class Trainer
+      def handle( llama )
+        llama.brush
+      end
+    end
+  end
+end

data/test/test_gem/lib/fun_with_llamas.rb

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

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: fun_with_gems
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bryce Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fun_with_files
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: fun_with_version_strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fun_with_testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: Dependency for FunWith gems, simplifies the setup of new gems, installing
+  version data, root filepath, and default requirements.
+email: keeputahweird@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ./lib/fun_with/gems/core_extensions/module.rb
+- ./lib/fun_with/gems/fun_gem_api.rb
+- ./lib/fun_with/gems/gem_api.rb
+- ./lib/fun_with/gems/mechanic.rb
+- ./lib/fun_with/gems/validator.rb
+- ./lib/fun_with_gems.rb
+- ./test/helper.rb
+- ./test/test_fun_with_gems.rb
+- ./test/test_gem/VERSION
+- ./test/test_gem/lib/fun_with/llamas/llama.rb
+- ./test/test_gem/lib/fun_with/llamas/trainer.rb
+- ./test/test_gem/lib/fun_with_llamas.rb
+- CHANGELOG.markdown
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+homepage: http://github.com/darthschmoo/fun_with_gems
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ! 'Dependency for most of my FunWith:: gems.  Not much use standalone.'
+test_files: []