olag 0.1.10

data/lib/olag/string_unindent.rb

@@ -0,0 +1,19 @@
+# Extend the core String class.
+class String
+
+  # Strip away common indentation from the beginning of each line in this
+  # String. By default, detects the indentation from the first line. This can
+  # be overriden to the exact (String) indentation to strip, or to the (Fixnum)
+  # number of spaces the first line is further-indented from the rest of the
+  # text.
+  def unindent(unindentation = 0)
+    unindentation = " " * (indentation.length - unindentation) if Fixnum === unindentation
+    return gsub(/^#{unindentation}/, "")
+  end
+
+  # Extract the indentation from the beginning of this String.
+  def indentation
+    return sub(/[^ ].*$/m, "")
+  end
+
+end

data/lib/olag/test.rb

@@ -0,0 +1,8 @@
+require "olag/test/with_errors"
+require "olag/test/with_fakefs"
+require "olag/test/with_rake"
+require "olag/test/with_tempfile"
+
+# Enhance the global test module with additional mix-in modules.
+module Test
+end

data/lib/olag/test/with_errors.rb

@@ -0,0 +1,26 @@
+require "olag/errors"
+
+module Test
+
+  # Mix-in for tests that collect Errors.
+  module WithErrors
+
+    # Aliasing methods needs to be deferred to when the module is included
+    # and be executed in the context of the class.
+    def self.included(base)
+      base.class_eval do
+
+        alias_method :errors_original_setup, :setup
+
+        # Automatically create an fresh +@errors+ data member for each test.
+        def setup
+          errors_original_setup
+          @errors = Olag::Errors.new
+        end
+
+      end
+    end
+
+  end
+
+end

data/lib/olag/test/with_fakefs.rb

@@ -0,0 +1,36 @@
+require "fakefs/safe"
+
+module Test
+
+  # Mix-in for tests that use the FakeFS fake file system.
+  module WithFakeFS
+
+    # Aliasing methods needs to be deferred to when the module is included and
+    # be executed in the context of the class.
+    def self.included(base)
+      base.class_eval do
+
+        alias_method :fakefs_original_setup, :setup
+
+        # Automatically create an fresh fake file system for each test.
+        def setup
+          fakefs_original_setup
+          FakeFS.activate!
+          FakeFS::FileSystem.clear
+        end
+
+        alias_method :fakefs_original_teardown, :teardown
+
+        # Automatically clean up the fake file system at the end of each test.
+        def teardown
+          fakefs_original_teardown
+          FakeFS.deactivate!
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/olag/test/with_rake.rb

@@ -0,0 +1,34 @@
+module Test
+
+  # Mix-in for tests that use Rake.
+  module WithRake
+
+    # Aliasing methods needs to be deferred to when the module is included
+    # and be executed in the context of the class.
+    def self.included(base)
+      base.class_eval do
+
+        alias_method :rake_original_setup, :setup
+
+        # Automatically create a fresh Rake application.
+        def setup
+          rake_original_setup
+          @original_rake = Rake.application
+          @rake = Rake::Application.new
+          Rake.application = @rake
+        end
+
+        alias_method :rake_original_teardown, :teardown
+
+        # Automatically restore the original Rake application.
+        def teardown
+          rake_original_teardown
+          Rake.application = @original_rake
+        end
+
+      end
+    end
+
+  end
+
+end

data/lib/olag/test/with_tempfile.rb

@@ -0,0 +1,49 @@
+require "fileutils"
+
+module Test
+
+  # Mix-in for tests that write a temporary disk file.
+  module WithTempfile
+
+    # Create a temporary file on the disk. The file will be automatically
+    # removed when the test is done.
+    def write_tempfile(path, content, directory = ".")
+      file = Tempfile.open(path, directory)
+      file.write(content)
+      file.close(false)
+      (@tempfiles ||= []) << (path = file.path)
+      return path
+    end
+
+    # Create a temporary directory on the disk. The directory will be
+    # automatically removed when the test is done. This is very useful for
+    # complex file tests that can't use FakeFS.
+    def create_tempdir(directory = ".")
+      file = Tempfile.open("dir", directory)
+      (@tempfiles ||= []) << (path = file.path)
+      File.delete(path)
+      Dir.mkdir(path)
+      return path
+    end
+
+    # Aliasing methods needs to be deferred to when the module is included and
+    # be executed in the context of the class.
+    def self.included(base)
+      base.class_eval do
+
+        alias_method :tempfile_original_teardown, :teardown
+
+        # Automatically clean up the temporary files when the test is done.
+        def teardown
+          tempfile_original_teardown
+          (@tempfiles || []).each do |tempfile|
+            FileUtils.rm_rf(tempfile) if File.exist?(tempfile)
+          end
+        end
+
+      end
+
+    end
+  end
+
+end

data/lib/olag/update_version.rb

@@ -0,0 +1,53 @@
+module Olag
+
+  module Version
+
+    # Update the file containing the gem's version. The file is expected to
+    # contain a line in the format: <tt>VERSION =
+    # "_major_._minor_._commits_"</tt>. The third number is updated according
+    # to the number of Git commits. This works well as long as we are working
+    # in the master branch.
+    def self.update(path)
+      current_file_contents, current_version, correct_version = current_status(path)
+      if current_version != correct_version
+        correct_file_contents = current_file_contents.sub(current_version, correct_version)
+        File.open(path, "w") { |file| file.write(correct_file_contents) }
+      end
+      return correct_version
+    end
+
+  protected
+
+    # Return the current version file contents, the current version, and the
+    # correct version.
+    def self.current_status(path)
+      prefix, current_suffix = extract_version(path, current_file_contents = File.read(path))
+      correct_suffix = count_git_commits.to_s
+      current_version = prefix + current_suffix
+      correct_version = prefix + correct_suffix
+      return current_file_contents, current_version, correct_version
+    end
+
+    # Extract the version number from the contents of the version file. This is
+    # an array of two strings - the prefix containing the major and minor
+    # numbers, and the suffix containing the commits number.
+    def self.extract_version(path, file_contents)
+      abort("#{path}: Does not contain a valid VERSION line.") unless file_contents =~ /VERSION\s+=\s+["'](\d+\.\d+\.)(\d+)["']/
+      return [ $1, $2 ]
+    end
+
+    # Return the total number of Git commits that apply to the current state of
+    # the working directory. This means we add one to the actual number of
+    # commits if there are uncommitted changes; this way the version number
+    # does not change after doing a commit - it only changes after we make
+    # changes following a commit.
+    def self.count_git_commits
+      git_commits = IO.popen("git rev-list --all | wc -l").read.chomp.to_i
+      git_status = IO.popen("git status").read
+      git_commits += 1 unless git_status.include?("working directory clean")
+      return git_commits
+    end
+
+  end
+
+end

data/lib/olag/version.rb

@@ -0,0 +1,8 @@
+# This module contains all the Olag code.
+module Olag
+
+  # This version number. The third number is automatically updated to track the
+  # number of Git commits by running <tt>rake version</tt>.
+  VERSION = "0.1.10"
+
+end

data/test/access_data_files.rb

@@ -0,0 +1,15 @@
+require "olag/data_files"
+require "test/spec"
+
+# Test accessing data files packages with the gem.
+class TestAccessDataFiles < Test::Unit::TestCase
+
+  def test_access_data_file
+    File.exist?(Olag::DataFiles.expand_path("olag/data_files.rb")).should == true
+  end
+
+  def test_access_missing_file
+    Olag::DataFiles.expand_path("no-such-file").should == "no-such-file"
+  end
+
+end

data/test/collect_errors.rb

@@ -0,0 +1,33 @@
+require "olag/errors"
+require "olag/test"
+require "test/spec"
+
+# Test collecting errors.
+class TestCollectErrors < Test::Unit::TestCase
+
+  include Test::WithErrors
+
+  def test_one_error
+    @errors << "Oops"
+    @errors.should == [ "#{$0}: Oops" ]
+  end
+
+  def test_path_error
+    @errors.in_path("foo") do
+      @errors << "Eeek"
+      "result"
+    end.should == "result"
+    @errors << "Oops"
+    @errors.should == [ "#{$0}: Eeek in file: foo", "#{$0}: Oops" ]
+  end
+
+  def test_line_error
+    @errors.in_path("foo") do
+      @errors.at_line(1)
+      @errors << "Eeek"
+    end
+    @errors << "Oops"
+    @errors.should == [ "#{$0}: Eeek in file: foo at line: 1", "#{$0}: Oops" ]
+  end
+
+end

data/test/missing_keys.rb

@@ -0,0 +1,17 @@
+require "olag/hash_struct"
+require "test/spec"
+
+# Test accessing missing keys as members.
+class TestMissingKeys < ::Test::Unit::TestCase
+
+  def test_read_missing_key
+    {}.missing.should == nil
+  end
+
+  def test_set_missing_key
+    hash = {}
+    hash.missing = "value"
+    hash.missing.should == "value"
+  end
+
+end

data/test/run_application.rb

@@ -0,0 +1,44 @@
+require "olag/application"
+require "olag/test"
+require "test/spec"
+
+# An application that emits an error when run.
+class ErrorApplication < Olag::Application
+
+  # Run the error application.
+  def run
+    super { @errors << "Oops!" }
+  end
+
+end
+
+# Test running a Olag Application.
+class TestRunApplication < Test::Unit::TestCase
+
+  include Test::WithFakeFS
+
+  def test_do_nothing
+    Olag::Application.with_argv([]) { Olag::Application.new(true).run }.should == 0
+  end
+
+  def test_extra_arguments
+    Olag::Application.with_argv(%w(-e stderr dummy)) { Olag::Application.new(true).run }.should == 1
+    File.read("stderr").should.include?("Expects no command line file arguments")
+  end
+
+  def test_print_version
+    Olag::Application.with_argv(%w(-o nested/stdout -v -h)) { Olag::Application.new(true).run }.should == 0
+    File.read("nested/stdout").should == "#{$0}: Version: #{Olag::VERSION}\n"
+  end
+
+  def test_print_help
+    Olag::Application.with_argv(%w(-o stdout -h -v)) { Olag::Application.new(true).run }.should == 0
+    File.read("stdout").should.include?("DESCRIPTION:")
+  end
+
+  def test_print_errors
+    Olag::Application.with_argv(%w(-e stderr)) { ErrorApplication.new(true).run }.should == 1
+    File.read("stderr").should.include?("Oops!")
+  end
+
+end

data/test/unindent_text.rb

@@ -0,0 +1,26 @@
+require "olag/string_unindent"
+require "test/spec"
+
+# Test unindenting a multi-line text.
+class TestUnindentText < ::Test::Unit::TestCase
+
+  def test_automatic_unindent
+    <<-EOF.unindent.should == "a\n  b\n"
+      a
+        b
+    EOF
+  end
+
+  def test_invalid_unindent
+    "    a\n  b\n".unindent.should == "a\n  b\n"
+  end
+
+  def test_integer_unindent
+    "  a\n    b\n".unindent(1).should == " a\n   b\n"
+  end
+
+  def test_string_unindent
+    "  a\n    b\n".unindent(" ").should == " a\n   b\n"
+  end
+
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification 
+name: olag
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 10
+  version: 0.1.10
+platform: ruby
+authors: 
+- Oren Ben-Kiki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: Saikuro
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: codnar
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: flay
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: roodi
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+description: Olag is Oren's set of utilities for creating a well-behaved gem. This is very opinionated software; it eliminates a lot of the boilerplate, at the cost of making many decisions which may not be suitable for everyone (directory structure, code verification, codnar for documentation, etc.).
+email: rubygems-oren@ben-kiki.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- ChangeLog
+files: 
+- lib/olag/application.rb
+- lib/olag/change_log.rb
+- lib/olag/data_files.rb
+- lib/olag/errors.rb
+- lib/olag/gem_specification.rb
+- lib/olag/globals.rb
+- lib/olag/hash_struct.rb
+- lib/olag/rake.rb
+- lib/olag/string_unindent.rb
+- lib/olag/test/with_errors.rb
+- lib/olag/test/with_fakefs.rb
+- lib/olag/test/with_rake.rb
+- lib/olag/test/with_tempfile.rb
+- lib/olag/test.rb
+- lib/olag/update_version.rb
+- lib/olag/version.rb
+- doc/root.html
+- doc/system.markdown
+- Rakefile
+- codnar.html
+- test/access_data_files.rb
+- test/collect_errors.rb
+- test/missing_keys.rb
+- test/run_application.rb
+- test/unindent_text.rb
+- README.rdoc
+- LICENSE
+- ChangeLog
+homepage: https://rubygems.org/gems/olag
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Olag 0.1.10
+- --main
+- README.rdoc
+- --line-numbers
+- --all
+- --quiet
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Olag - Oren's Library/Application Gem framework
+test_files: 
+- test/access_data_files.rb
+- test/collect_errors.rb
+- test/missing_keys.rb
+- test/run_application.rb
+- test/unindent_text.rb