development 1.0.8 → 1.1.0

data/CHANGELOG.md

@@ -11,3 +11,6 @@ Directories can now specify either the directory the gem directory is in or the
 We now support Bundler!
 Removed all dependencies.
 
+== 7/10/2012
+
+Rewrote for configuration file in Ruby.

data/README.md

@@ -45,88 +45,65 @@ I would make project-specific .development files a requirement (to avoid acciden
 
 ### Configuration File Example ###
 
-	###
-	# Ruby 'development' configuration file (.development).
-	#
-	# * # denotes comment.
-	# * Indentation is treated as a line continuation.
-	# * Items can be separated by , or simply by whitespace.
-	# * Length of whitespace is irrelevant - contiguous whitespace is "one unit".
-	#
-
-	###
-	# Any lines beginning with plain text (not =, +, -, @, !) will be interpreted as general directory expressions.
-	# It is not necessary to specify any general directories. Multiple directories may be specified, one per line.
-	#
-	# Uncomment the line below to look for directories with gem name in ~/ruby_projects. Any directories specified
-	# in this way will be used in the case that no explicit specification exists for gem name in question.
-	#
-	# ~/ruby_projects
-
-	###
-	# Declare a gemset to group a set of gems and configure them by a single reference.
-	#
-	# Gems are permitted to be in multiple sets, with first match (from top of .development file downward) winning.
-	#
-	# =<gemset_name> gem-name, ...
-	#
-
-	=ruby                 module-cluster
-
-	=hooked_objects       hash-hooked 
-	                      array-hooked 
-	                      array-sorted 
-	                      array-unique 
-	                      array-sorted-unique
-
-	=compositing_objects  hash-compositing
-	                      array-compositing
-	                      array-sorted-compositing
-	                      array-unique-compositing
-	                      array-sorted-unique-compositing
-
-	=ridiculous_power     persistence
-	                      magnets
-
-	###
-	# Declare named locations to associate gems or gemsets with specific locations.
-	#
-	# +directory_name path, ...
-	#
-	# Paths that begin with @ will interpolate the directory name as the starting portion of the path.
-	#
-
-	+code                 ~/Projects
-	+ridiculous_power     @code/rp
-	+ruby                 @ridiculous_power/ruby
-
-	+hooked_objects       @ruby/hooked_objects
-	+compositing_objects  @ruby/compositing_objects
-
-	###
-	# Declare lookup locations for specific gems.
-	#
-	# Named paths listed on there own 
-	#
-
-	@hooked_objects       hooked_objects
-	@compositing_objects  compositing_objects
-
-	@ridiculous_power     ridiculous_power
-
-	###
-	# !enable and !disable can be used to cause production gems to be used.
-	# 
-	# * !enable or !disable on its own will enable or disable all gems and change the default (enabled/disabled), 
-	#   after which individual gems can be enabled or disabled.
-	#
-	# * !enable or !disable followed by a gem name or a gemset name will enable or disable that gem/gemset.
-	#
-	# Nothing is enabled to start. Call !enable to use .development specifications in all cases; after
-	# !enable individual gems/sets/paths can be enabled/disabled.
-	#
-
-	!enable 
+#### Short Example ####
+
+```ruby
+enable! :parallel_ancestry => '~/Projects/rp/ruby/parallel_ancestry'
+```
+
+#### Extended Example ####
+
+```ruby
+###
+# Declare named locations to associate gems or gemsets with specific locations.
+#   If a directory exists by name of gem or gemset it will be used automatically.
+#   Otherwise the directory will have to be declared explicitly.
+#
+directory( :code, '~/Projects' )
+
+###
+# Paths can start with names of other paths.
+#
+directory( :ridiculous_power, :code, 'rp' )
+
+directory( :ruby, :ridiculous_power, 'ruby' )
+directory( :hooked_objects, :ruby, 'hooked_objects' )
+directory( :compositing_objects, :ruby, 'compositing_objects' )
+
+###
+# Add gems or gemsets to directory.
+#
+directory( :ridiculous_power ).add( 'persistence', 'magnets' )
+
+###
+# Declare a gemset to group a set of gems and configure them by a single reference.
+#
+gemset( :ruby,                'module-cluster', 
+                              'parallel_ancestry', 
+                              'identifies_as' )
+
+gemset( :hooked_objects,      'hash-hooked', 
+                              'array-hooked', 
+                              'array-sorted', 
+                              'array-unique', 
+                              'array-sorted-unique' )
+
+gemset( :compositing_objects, 'hash-compositing', 
+                              'array-compositing', 
+                              'array-sorted-compositing', 
+                              'array-unique-compositing', 
+                              'array-sorted-unique-compositing' )
+
+###
+# Specify directory by gem or gemset.
+#
+gem( 'to_lambda' ).directory( :ruby )
+
+###
+# Enable all (no parameters) or specific gems.
+#
+enable! :ruby, :hooked_objects, :compositing_objects, :parallel_ancestry
+```
 
 # License #
 

data/lib/development/configuration_interface.rb

@@ -0,0 +1,123 @@
+
+###
+# @private
+#
+# Interface with Object instance methods for use from configuration file since
+#   load cannot load into a context line by line.
+#
+module ::Development::ConfigurationInterface
+  
+  ################
+  #  gem_method  #
+  ################
+  
+  ###
+  # Define a gem or retrieve defined gem.
+  #
+  # @param name
+  #
+  #        Name of gem.
+  #
+  # @param directory_or_path
+  #
+  #        Development::Directory or String describing path.
+  #
+  # @return [::Development::Gem]
+  #
+  def gem_method( name, directory_or_path = nil )
+    return ::Development.gem( name, directory_or_path )
+  end
+  
+  ############
+  #  gemset  #
+  ############
+
+  ###
+  # Define a gem or retrieve defined gem.
+  #
+  # @overload self.gemset( name, gem_or_gemset, ... )
+  #
+  #   @param name
+  #   
+  #          Name of gemset.
+  #
+  #   @param gem_or_gemset
+  #
+  #          Gem or Gemset name or instance.
+  #
+  # @return [::Development::Gemset]
+  #
+  def gemset( name, *gems_or_gemsets )
+    return ::Development.gemset( name, *gems_or_gemsets )
+  end
+
+  ###############
+  #  directory  #
+  ###############
+  
+  ###
+  # Return path for directory name.
+  #
+  # @overload self.directory( name, path, gem_or_gemset, ... )
+  #
+  #   @param directory_name
+  #   
+  #          Name of named directory.
+  #   
+  #   @param path
+  #   
+  #          String describing directory path.
+  #
+  #   @param gem_or_gemset
+  #   
+  #          Gem or Gemset or String or Symbol describing Gem or Gemset.
+  #
+  # @return [::Development::Directory] Directory.
+  #
+  def directory( name, *path_parts )
+    return ::Development.directory( name, *path_parts )
+  end
+
+  #############
+  #  enable!  #
+  #############
+  
+  ###
+  # Enable gems.
+  #
+  # @overload enable!
+  #
+  # @overload enable( gem_or_gemset, ... )
+  #
+  #   @param gem_or_gemset 
+  #
+  #          Gem or Gemset instance or name to enable.
+  #
+  # @return [::Development] Self. 
+  #
+  def enable!( *gem_or_gemset_names )
+    return ::Development.enable!( *gem_or_gemset_names )
+  end
+
+  ##############
+  #  disable!  #
+  ##############
+
+  ###
+  # Disable gems.
+  #
+  # @overload disable!
+  #
+  # @overload disable( gem_or_gemset, ... )
+  #
+  #   @param gem_or_gemset 
+  #
+  #          Gem or Gemset instance or name to disable.
+  #
+  # @return [::Development] Self. 
+  #
+  def disable!( *gem_or_gemset_names )
+    return ::Development.disable!( *gem_or_gemset_names )
+  end
+
+end

data/lib/development/directory/directory_interface.rb

@@ -0,0 +1,165 @@
+
+###
+# Interface for directory implementation. Implementation provided separately for ease of overloading.
+#
+module ::Development::Directory::DirectoryInterface
+
+  ################
+  #  initialize  #
+  ################
+  
+  ###
+  #
+  # @overload initialize( name, path_part, ... )
+  #
+  #   @param name
+  #
+  #          Reference name for directory.
+  #   
+  #   @param path_part
+  #
+  #          Part of path; the first can be a symbol referring to a named path or a string,
+  #          all other parts must be strings.
+  #
+  def initialize( name, *path_parts )
+
+    @name = name
+        
+    self.set_path( *path_parts )
+    
+    # a directory is also a gemset
+    @gemset = ::Development.gemset( name )
+    @gemset.set_directory( self )
+
+    # if there's a gem or gemset name by this directory name, 
+    # we use it unless gem or gemset already has a directory
+    if name
+      if gem_instance = ::Development.get_gem( name )
+        gem_instance.set_directory( self )
+      end
+
+      if gemset_instance = ::Development.get_gemset( name )
+        gemset_instance.set_directory( self )
+      end
+    end
+    
+  end
+
+  ##########
+  #  name  #
+  ##########
+  
+  ###
+  # Name.
+  #
+  # @!attribute [reader] Name.
+  #
+  attr_reader :name
+
+  #############
+  #  members  #
+  #############
+  
+  ###
+  # Gems or Gemsets with self as their directory.
+  #
+  # @return [Array<::Development::Gem,::Development::Gemset>] Members
+  #
+  def members
+    
+    return @gemset.members
+    
+  end
+  
+  ##########
+  #  path  #
+  ##########
+  
+  ###
+  # Path.
+  #
+  # @!attribute [reader] Name.
+  #
+  attr_reader :path
+  
+  ##############
+  #  set_path  #
+  ##############
+  
+  ###
+  # Set Path.
+  #
+  # @param path
+  #
+  #        Path string.
+  #
+  # @return [::Development::Directory] Self.
+  #
+  def set_path( *path_parts )
+    
+    if path_parts[ 0 ].is_a?( ::Symbol )
+      base_directory_name = path_parts[ 0 ]
+      base_directory = ::Development.get_directory( base_directory_name )
+      path_parts[ 0 ] = base_directory.path
+    end
+    
+    path_parts.collect!( & :to_s )
+    
+    if path_parts[ 0 ].nil?
+      @path = nil
+    else
+      @path = ::File.expand_path( ::File.join( *path_parts ) )
+    end
+    
+    return self
+    
+  end
+  
+  #########
+  #  add  #
+  #########
+  
+  ###
+  # Add gems or gemsets to directory.
+  #
+  # @overload add( gem_or_gemset, ... )
+  #
+  #   @param gem_or_gemset
+  #
+  #          Gem or Gemset instance or name to add to directory.
+  #
+  # @return [::Development::Directory] Self.
+  #
+  def add( *gems_or_gemsets )
+    
+    @gemset.add( *gems_or_gemsets )
+
+    return self
+    
+  end
+
+  ############
+  #  delete  #
+  #  remove  #
+  ############
+  
+  ###
+  # Remove gems or gemsets from directory.
+  #
+  # @overload delete( gem_or_gemset, ... )
+  #
+  #   @param gem_or_gemset
+  #
+  #          Gem or Gemset instance or name to add to directory.
+  #
+  # @return [::Development::Directory] Self.
+  #
+  def delete( *gems_or_gemsets )
+    
+    return @gemset.delete( *gems_or_gemsets )
+    
+  end
+  
+  alias_method :remove, :delete
+
+end

data/lib/development/directory.rb

@@ -0,0 +1,9 @@
+
+###
+# Directory class.
+#
+class ::Development::Directory
+  
+  include ::Development::Directory::DirectoryInterface
+  
+end