rubinius-toolset 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2aad3df20490e7a2c8e152d1eddb761507af34f
-  data.tar.gz: 4906ca7ef0d5e91d91027c161a4c9c042334a34b
+  metadata.gz: d8f0825196ed5777cfc710909b29e10aa3d20667
+  data.tar.gz: 5a72876dca2c3aebbf9a66a06dfd74ac617b0bac
 SHA512:
-  metadata.gz: a08a7edbad2974977ca83fd4932452ac70d557744940eff7927cda5463dac33e346459b8604894392e148c053edc4112c054f25b5724fd064f716638a25905ed
-  data.tar.gz: 7778d1ffef79250342255372009cf36551a9f094f6f8e446bb3c110ee8703fd29bdbbe66a6e034c35cb0fe64e21bbc65d8b87b1161efc4d97fe2f88ccbec19c7
+  metadata.gz: f19965971f1a89d744fcba5561f756955149f9464df94084f4aa87c7c68180193de60f2008f6b0e5e53cdb22bd0fc5bd1a06fcc935627760857b92fb0ac53661
+  data.tar.gz: 7eb5c692a474c1cf7464abfc1eab50df70fddae78d8cafe3e7e8cdaca26db05af370fc4ae48457ea954bbdc8744c6c4f51e13473c608295c24e71fc452fc17c4

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
-  - RUBYLIB=.
+env:
+  - RUBYLIB=lib:.
 script: mspec -r spec/spec_helper spec
 rvm:
+  - 1.8.7
   - 2.1.0
+  - 2.1.1
   - rbx-2

data/README.md

@@ -1,11 +1,11 @@
-# Rubinius::Toolset
+# Rubinius::Toolsets
 
-Rubinius::ToolSet provides a registry for code tools. These include
-the Rubinius bytecode compiler and parser. These, in turn, depend on
-other components like the AST and bytecode emitter and serializer.
+Rubinius::ToolSets provides a registry for code tools.
 
-ToolSets provide a mechanism for other languages to reuse as much of
-the Rubinius code tools as are suitable for that language.
+The goal of ToolSets is to provide a mechanism for sharing as much as possible
+between the Rubinius build tools (e.g. the parser, the AST, tools to operate
+on bytecode) and custom build tools for specific tasks or for other languages
+targeting Rubinius.
 
 ## Installation
 
@@ -23,7 +23,59 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+There are two operations on ToolSets:
+
+1. Creating a new ToolSet.
+2. Accessing the current ToolSet.
+
+Create a new ToolSet before defining or loading the classes and modules that
+implement code tools. Access the current ToolSet to build up its various parts
+as a consistent whole.
+
+To define a ToolSet in separate pieces, use the following example:
+
+```ruby
+# my_code_tools.rb
+# Entry point to defining MyCodeTools
+Rubinius::ToolSets.create :my_code_tools
+
+# my_code_tools/some_tool.rb
+module Rubinius::ToolSets.current::ToolSet
+  # define a tool
+end
+```
+
+Alternatively, define a ToolSet by requiring files in a block as follows:
+
+```ruby
+Rubinius::ToolSets.create :my_code_tools do
+  require "my_code_tools"
+end
+```
+
+The advantage of the latter approach is that multiple ToolSets can be created
+from some of the same files because `$LOADED_FEATURES` are reset when yielding
+to the block.
+
+## Reference
+
+### Rubinius::ToolSets.create([name [, &block]])
+
+Creates a new ToolSet.
+
+If name is not given, the ToolSet is not assigned to a constant under
+`Rubinius::ToolSets`. If the name is given, it is camelized and set as a
+constant under Rubinius::ToolSets.
+
+If a block is passed, `$LOADED_FEATURES` is cleared before yielding to the
+block and reset afterwards. The ToolSet is yielded to the block.
+
+Calling `Rubinius::ToolSet.create` a second time creates a new ToolSet.
+
+### Rubinius::ToolSets.current
+
+Returns the ToolSet that is being defined. If called before `.create`, a new,
+anonymous ToolSet is created.
 
 ## Contributing
 

data/lib/rubinius/toolset/version.rb

@@ -1,5 +1,5 @@
 module Rubinius
-  module Toolset
-    VERSION = "2.1.0"
+  module ToolSets
+    VERSION = "2.2.0"
   end
 end

data/lib/rubinius/toolset.rb

@@ -1,60 +1,35 @@
 require "rubinius/toolset/version"
 
 module Rubinius
-  module ToolSet
-    # Returns the module enclosing the current toolset.
-    def self.current
-      @current ||= Module.new
-    end
-
-    # Start a new toolset module by clearing out the current one
-    def self.start
-      @current = nil
-    end
-
-    # Access the Hash containing the finished toolset modules
-    def self.map
-      @map ||= {}
-    end
-
-    # Finish the current toolset module by registering it with a name
-    def self.finish(name)
-      ts = current::TS
-      ts.const_set :ToolSet, ts
-      map[name] = ts
-      const_set name.to_s.capitalize.to_sym, ts
-    end
-
-    # Get a finished toolset module by name
-    def self.get(name)
-      map[name]
-    end
-
-    # Set the current toolset module as a constant on Rubinius::ToolSet
-    def self.attach(name)
-      return unless name
-
-      map[name] = current
-
-      name = name.to_s.split("_").map { |x| x.capitalize }.join
-      const_set name, current
-
-      current.const_set :TS, current
-      current::TS.const_set :ToolSet, current
-    end
-
-    # Create a new toolset, optionally with a name. The module enclosing the
-    # toolset yielded to the block.
+  module ToolSets
+    # Create a new ToolSet, with an optional name. The ToolSet is yielded to
+    # the optional block.
     def self.create(name=nil)
-      loaded_features = $LOADED_FEATURES
-      $LOADED_FEATURES.clear
-
-      start
-      attach name
+      @current = Module.new
+      @current.const_set :ToolSet, @current
+
+      if name
+        name = name.to_s.split("_").map { |x| x.capitalize }.join
+        const_set name, @current
+      end
+
+      if block_given?
+        begin
+          loaded_features = $LOADED_FEATURES
+          $LOADED_FEATURES.clear
+
+          yield @current
+        ensure
+          $LOADED_FEATURES.replace loaded_features
+        end
+      end
+
+      @current
+    end
 
-      yield current
-    ensure
-      $LOADED_FEATURES.replace loaded_features
+    # Returns the current ToolSet.
+    def self.current
+      @current ||= create
     end
   end
 end

data/rubinius-toolset.gemspec

@@ -3,7 +3,7 @@ require './lib/rubinius/toolset/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "rubinius-toolset"
-  spec.version       = Rubinius::Toolset::VERSION
+  spec.version       = Rubinius::ToolSets::VERSION
   spec.authors       = ["Brian Shirai"]
   spec.email         = ["brixen@gmail.com"]
   spec.description   = <<-EOD
@@ -26,4 +26,5 @@ the Rubinius code tools as are suitable for that language.
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubinius-bridge", "~> 1.0"
 end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
+require 'rubygems'
 require 'rubinius/bridge'
 require 'lib/rubinius/toolset'

data/spec/toolset_spec.rb

@@ -1,63 +1,41 @@
-describe "Rubinius::ToolSet.current" do
-  it "returns a Module" do
-    Rubinius::ToolSet.current.should be_an_instance_of(Module)
+describe "Rubinius::ToolSets.create" do
+  it "creates a new ToolSet" do
+    m = Rubinius::ToolSets.current
+    Rubinius::ToolSets.create.should_not equal(m)
   end
-end
-
-describe "Rubinius::ToolSet.finish" do
-  before do
-    Rubinius::ToolSet.start
-    module Rubinius::ToolSet.current::TS; end
-  end
-
-  it "adds name to the ToolSet map" do
-    Rubinius::ToolSet.finish :testing
-    Rubinius::ToolSet.map.keys.should include(:testing)
-  end
-
-  it "sets a constant on ToolSet with the capitalized name" do
-    Rubinius::ToolSet.finish :name
-    Rubinius::ToolSet::Name.should be_an_instance_of(Module)
-  end
-end
 
-describe "Rubinius::ToolSet.create" do
-  it "it resets $LOADED_FEATURES while running the block" do
-    Rubinius::ToolSet.create do
-      $LOADED_FEATURES.should == []
-    end
+  it "accepts an optional name for the ToolSet" do
+    ts = Rubinius::ToolSets.create :a_tool_set
+    ts.name.should == "Rubinius::ToolSets::AToolSet"
   end
 
-  it "yields an anonymous Module to the block if no name is given" do
-    Rubinius::ToolSet.create do |m|
-      m.should be_an_instance_of(Module)
-      m.name.should be_nil
+  it "sets .current to the ToolSet that is yielded to the block" do
+    Rubinius::ToolSets.create do |ts|
+      ts.should equal(Rubinius::ToolSets.current)
     end
   end
 
-  it "sets .current to the module that is yielded to the block" do
-    Rubinius::ToolSet.create do |m|
-      m.should equal(Rubinius::ToolSet.current)
+  it "resets $LOADED_FEATURES while running the block" do
+    Rubinius::ToolSets.create do
+      $LOADED_FEATURES.should == []
     end
   end
 
-  it "accepts an optional name for the toolset module" do
-    Rubinius::ToolSet.create :a_tool_set do |m|
-      m.name.should == "Rubinius::ToolSet::AToolSet"
+  it "sets the 'ToolSet' constant on the yielded ToolSet to refer to itself" do
+    Rubinius::ToolSets.create :spec do |ts|
+      ts.should equal(ts::ToolSet)
     end
   end
+end
 
-  it "creates a temporary module named 'TS' on the current toolset module" do
-    Rubinius::ToolSet.create :spec do |m|
-      m.should equal(m::TS)
-      m::TS.name.should == "Rubinius::ToolSet::Spec"
-    end
+describe "Rubinius::ToolSets.current" do
+  it "returns the ToolSet created by .create" do
+    ts = Rubinius::ToolSets.create
+    Rubinius::ToolSets.current.should equal(ts)
   end
 
-  it "creates a ToolSet module under the TS module" do
-    Rubinius::ToolSet.create :spec do |m|
-      m::TS.should equal(m::TS::ToolSet)
-      m::TS::ToolSet.name.should == "Rubinius::ToolSet::Spec"
-    end
+  it "returns the same ToolSet on each call" do
+    ts = Rubinius::ToolSets.current
+    ts.should equal(Rubinius::ToolSets.current)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubinius-toolset
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-01 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubinius-bridge
+  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'
 description: |
   Rubinius::ToolSet provides a registry for code tools. These include
   the Rubinius bytecode compiler and parser. These, in turn, depend on
@@ -96,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A registry for Rubinius code tools