amp-core 0.1.0

data/lib/amp-core/support/string_utils.rb

@@ -0,0 +1,86 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+require 'digest'
+
+module Amp
+  module Core
+    module Support
+      # This module is a set of string functions that we use frequently.
+      # They sued to be monkey-patched onto the String class, but we don't
+      # do that anymore.
+      module StringUtils
+        module_function
+        
+        # Converts this text into hex. each letter is replaced with
+        # it's hex counterpart 
+        def hexlify(src)
+          str = ""
+          src.each_byte do |i|
+            str << i.to_s(16).rjust(2, "0")
+          end
+          str
+        end
+        
+        if RUBY_VERSION < "1.9"
+          # Returns the value of the first byte of the string.
+          #
+          # @return [Fixnum, 0 <= x < 256] The value of the first byte.
+          def ord(str)
+            raise ArgumentError.new('empty string') if str.empty?
+            str[0]
+          end
+          ##
+          # Converts a string of hex into the binary values it represents. This is used for
+          # when we store a node ID in a human-readable format, and need to convert it back.
+          #
+          # @example StringUtils.unhexlify("DEADBEEF") #=> "\336\255\276\357"
+          # @return [String] the string decoded from hex form
+          def unhexlify(src)
+            str = "\000" * (src.size/2)
+            c = 0
+            (0..src.size-2).step(2) do |i|
+              hex = src[i,2].to_i(16)
+              str[c] = hex
+              c += 1
+            end
+            str
+          end
+        else
+          # Returns the value of the first byte of the string.
+          #
+          # @return [Fixnum, 0 <= x < 256] The value of the first byte.
+          def ord(str)
+            raise ArgumentError.new('empty string') if str.empty?
+            str.ord
+          end
+
+          def unhexlify(str)
+            str = "\000" * (src.size/2)
+            c = 0
+            (0..src.size-2).step(2) do |i|
+              hex = src[i,2].to_i(16)
+              str[c] = hex.chr
+              c += 1
+            end
+            str
+          end
+        end
+        
+        def sha1(str)
+          Digest::SHA1.new.update(str)
+        end
+      end
+    end
+  end
+end

data/lib/amp-core/templates/git/blank.log.erb

@@ -0,0 +1,18 @@
+<%# This is the blank template file. Here's some information about the
+    variables you have access to in your ERb file!
+    
+    Note: This template is for when you want to print changesets.
+    
+    revision: the revision number of the changeset you're printing
+    change_node: the node ID of the changeset. This will be in binary,
+                 so you'll probably want to use hexlify to make it hexy.
+    branch: the name of the branch this changeset belongs to
+    parents: parents of the revision, as [index, node (as hex)]
+    username: the user who committed this changeset
+    date: the date this was committed
+    description: the message connected to the changeset
+    config: the entire configuration of the entire program! This includes
+            switches such as :verbose.
+    
+    Be sure to take a look at the default template, to get some ideas!
+%>

data/lib/amp-core/templates/git/default.log.erb

@@ -0,0 +1,18 @@
+changeset:  <%= revision %>
+<%- parents.each do |rent| -%>
+parent:     <%= "#{rent.short_name}" %>
+<%- end -%>
+user:       <%= username %>
+date:       <%= date %>
+<%- if config[:verbose] -%>
+files:      <%= files.join(" ") %>
+<%- end -%>
+<%- if description && description.any?
+    if config[:verbose] -%>
+description:
+<%= description %>
+<%- else -%>
+summary:    <%= description.split_lines_better.first.strip %>
+<%- end -%>
+<%- end -%>
+

data/lib/amp-core/templates/mercurial/blank.commit.erb

@@ -0,0 +1,23 @@
+
+
+AMP: Enter commit message. Lines beginning with 'AMP:' are removed.
+AMP: --
+AMP: <%= user %>
+<%- if parents[1] != NULL_REV -%>
+AMP: branch merge
+<%- end -%>
+<%- if branch -%>
+AMP: branch '<%= branch %>'
+<%- end -%>
+<%- added.each do |file| -%>
+AMP: added <%= file %>
+<%- end -%>
+<%- updated.each do |file| -%>
+AMP: changed <%= file %>
+<%- end -%>
+<%- removed.each do |file| -%>
+AMP: removed <%= file %>
+<%- end -%>
+<%- if added.size + updated.size + removed.size == 0 -%>
+AMP: no files changed
+<%- end -%>

data/lib/amp-core/templates/mercurial/blank.log.erb

@@ -0,0 +1,18 @@
+<%# This is the blank template file. Here's some information about the
+    variables you have access to in your ERb file!
+    
+    Note: This template is for when you want to print changesets.
+    
+    revision: the revision number of the changeset you're printing
+    change_node: the node ID of the changeset. This will be in binary,
+                 so you'll probably want to use hexlify to make it hexy.
+    branch: the name of the branch this changeset belongs to
+    parents: parents of the revision, as [index, node (as hex)]
+    username: the user who committed this changeset
+    date: the date this was committed
+    description: the message connected to the changeset
+    config: the entire configuration of the entire program! This includes
+            switches such as :verbose.
+    
+    Be sure to take a look at the default template, to get some ideas!
+%>

data/lib/amp-core/templates/mercurial/default.commit.erb

@@ -0,0 +1,23 @@
+
+
+AMP: Enter commit message. Lines beginning with 'AMP:' are removed.
+AMP: --
+AMP: <%= user %>
+<%- if parents[1] != nil -%>
+AMP: branch merge
+<%- end -%>
+<%- if branch -%>
+AMP: branch '<%= branch %>'
+<%- end -%>
+<%- added.each do |file| -%>
+AMP: added <%= file %>
+<%- end -%>
+<%- updated.each do |file| -%>
+AMP: changed <%= file %>
+<%- end -%>
+<%- removed.each do |file| -%>
+AMP: removed <%= file %>
+<%- end -%>
+<%- if added.size + updated.size + removed.size == 0 -%>
+AMP: no files changed
+<%- end -%>

data/lib/amp-core/templates/mercurial/default.log.erb

@@ -0,0 +1,26 @@
+<%- if config[:verbose] -%>
+changeset:  <%= revision %>:<%= change_node.hexlify %>
+<%- else -%>
+changeset:  <%= revision %>:<%= change_node[0..5].hexlify %>
+<%- end -%>
+branch:     <%= branch %>
+<%- parents.each do |index, node| -%>
+parent:     <%= "#{index}:#{node}" %>
+<%- end -%>
+<%- if cs_tags.any? -%>
+tags:       <%= cs_tags %>
+<%- end -%>
+user:       <%= username %>
+date:       <%= date %>
+<%- if config[:verbose] -%>
+files:      <%= files.join(" ") %>
+<%- end -%>
+<%- if description && description.any?
+    if config[:verbose] -%>
+description:
+<%= description %>
+<%- else -%>
+summary:    <%= description.split_lines_better.first.strip %>
+<%- end -%>
+<%- end -%>
+

data/lib/amp-core/templates/template.rb

@@ -0,0 +1,202 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+module Amp
+  module Support
+    ##
+    # = Template
+    # @author Michael Edgar
+    #
+    # Class representing a template in the amp system
+    class Template
+      
+      @all_templates = Hash.new {|h, k| h[k] = {} }
+      class << self
+        attr_accessor :all_templates
+        
+        ##
+        # Returns the template with the given name.
+        #
+        # @param [String, Symbol, #to_sym] template the name of the template to retrieve
+        # @return [Template] the template with the given name
+        def [](type, template)
+          ensure_templates_loaded
+          return all_templates[type.to_sym][template.to_sym] || all_templates[:all][template.to_sym]
+        end
+        
+        ##
+        # Registers a template with the Amp system. Should have a unique name.
+        #
+        # @param [String, Symbol, #to_sym] name the name of the template. Should be unique.
+        # @param [Template] template the template to register.
+        def register(type, name, template)
+          all_templates[type.to_sym][name.to_sym] = template
+        end
+        
+        ##
+        # Unregisters a template with the Amp system. If the name is not found, an exception
+        # is thrown.
+        #
+        # @param [String, Symbol, #to_sym] name the name of the template to remove from
+        #   the system.
+        def unregister(type, name)
+          raise ArgumentError.new("Unknown template: #{name}") unless all_templates[type.to_sym][name.to_sym]
+          all_templates[type.to_sym].delete name.to_sym
+        end
+        
+        ##
+        # Returns whether any templates have been loaded. Used for lazy loading of templates.
+        #
+        # @return [Boolean] have the default templates, or any templates, been loaded?
+        def templates_loaded?
+          all_templates.any?
+        end
+        
+        ##
+        # Registers the default templates. Separated into a method (instead of automatically
+        # run) because templates aren't used enough to justify the IO hit from loading them in.
+        def load_default_templates
+          Dir[File.expand_path(File.join(File.dirname(__FILE__), "**/*.erb"))].each do |f|
+            name = f.split('/').last.chomp('.erb').sub('.','-')
+            type = f.split('/')[-2]
+            FileTemplate.new(type, name, f)
+          end
+        end
+        
+        ##
+        # Makes sure the default templates have been loaded.
+        #
+        # About the use of instance_eval - this method could potentially be run more than once. There
+        # is no reason for it to ever run more than once. So we'll redefine it to do nothing.
+        def ensure_templates_loaded
+          load_default_templates
+          instance_eval do
+            def ensure_templates_loaded; end
+          end
+          true
+        end
+      end
+      
+      attr_accessor :name, :renderer, :text
+      
+      ##
+      # Creates a new template with the given values. The name is how you will reference the
+      # template using the --template option from the command line, so choose it wisely!
+      #
+      # @param [String, Symbol, #to_s] name the name of the template, which is invoked
+      #   using --template
+      # @param [Symbol] type the type of the template. Indicates the renderer used.
+      # @param [String] text the text of the template, which presumably has some templating
+      #   code to substitute in local variables and make a nice output system.
+      def initialize(type, name, renderer = :erb, text = "")
+        @name, @renderer, @text = name, renderer, text
+        Template.register(type, name, self)
+      end
+      
+      ##
+      # Renders the template with the given local variables. Uses whichever templating engine
+      # you set. Note: if you use HAML, you'll need to have HAML installed. This is why none
+      # of the default templates use HAML.
+      #
+      # @param [Hash] locals the local variables passed to the template. Works for HAML so far,
+      #   not for erb.
+      # @return [String] the parsed template
+      # @todo make locals work for ERb without bootleg hax
+      def render(locals = {}, render_binding = binding)        
+        case renderer.to_sym
+        when :erb
+          require 'erb'
+          locals_assigns = locals.map { |k,v| "#{k} = locals[#{k.inspect}]" }
+          eval locals_assigns.join("\n"), render_binding
+          
+          erb = ERB.new(text, 0, "-")
+          erb.result render_binding
+        when :haml
+          require 'rubygems'
+          require 'haml'
+          haml = Haml::Engine.new(text)
+          haml.render render_binding, locals
+        end
+      end
+      
+      private
+      
+    end
+    
+    ##
+    # = FileTemplate
+    # Class for loading a template from a file and registering it in the system.
+    # Is smart enough that if the filename ends in a known extension, the appropriate
+    # renderer will be used. Otherwise, you will have to specify the renderer.
+    class FileTemplate < Template
+      KNOWN_EXTENSIONS = ["erb", "haml"]
+    
+      attr_accessor :file
+      
+      ##
+      # Initializes a new FileTemplate with a file used as input.
+      #
+      # The renderer is inferred from the file's extension.
+      def initialize(type, name, file, renderer = nil)
+        if renderer.nil?
+          renderer = KNOWN_EXTENSIONS.select {|ext| file.end_with? ext}.first
+        end
+        raise ArgumentError.new("No renderer specified for #{file.inspect}") if renderer.nil?
+        @file = file
+        super(type, name, renderer, File.read(file))
+      end
+      
+      def save!
+        File.open(file, "w") { |out| out.write text }
+      end
+    end
+    
+    ##
+    # = RawTemplate
+    # Class for specifying a tiny bit of text to be interpreted as ERb code, and
+    # using that as a template.
+    class RawERbTemplate < Template
+      def initialize(text)
+        text = "<%= #{text} %>" unless text.include?("<%")
+        super(:raw, "raw#{(rand * 65535).to_i}", :erb, text)
+      end
+    end
+    
+  end
+end
+
+module Amp
+  module KernelMethods
+    ##
+    # @overload template(name, type, text)
+    #   Shortcut Kernel-level method for adding templates quickly. A nice
+    #   method for ampfiles.
+    #   @param [String] name the name of the template
+    #   @param [Symbol] type the template engine to use (such as :haml, :erb)
+    #   @param [String] text the text of the template
+    # @overload template(name, text)
+    #   Shortcut Kernel-level method for adding ERb templates quickly. A
+    #   nice method for ampfiles.
+    #   @param [String] name the name of the template    
+    #   @param [String] text the text of the template. Expected to be in ERb format.
+    def template(name, *args)
+      if args.size > 2 || args.empty?
+        raise ArgumentError.new('Usage of template: template(name, text)'+
+                                'or template(name, renderer, text)')
+      end
+      template = (args.size > 1) ? args[0] : :erb
+      Support::Template.new(:all, name, template, args.last)
+    end
+  end
+end

data/spec/amp-core_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "amp-core" do
+  it "should have a plugin constant: Amp::Plugins::Core" do
+    result = nil
+    Amp::Plugins.class_eval do
+      result = const_defined?(:Core)
+    end
+    result.should be_true
+  end
+end

data/spec/command_ext_specs/repository_loading_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Amp::Core::RepositoryLoading do
+  describe "#has_repo" do
+    before do
+      @class_with = Class.new(Amp::Command::Base) do
+        has_repo
+      end
+      @class_without = Class.new(Amp::Command::Base) do
+      end
+    end
+    
+    it "includes the module in a Command when it called" do
+      @class_with.included_modules.should
+          include(Amp::Core::RepositoryLoading)
+    end
+  
+    it "doesn't include the module in a Command when not called" do
+      @class_without.included_modules.should_not
+          include(Amp::Core::RepositoryLoading)
+    end
+  
+    it "extends the new class with ClassMethods when called" do
+      (class << @class_with; self; end).included_modules.should
+          include(Amp::Core::RepositoryLoading::ClassMethods)
+    end
+
+    it "doesn't extend the new class with ClassMethods when not called" do
+      (class << @class_without; self; end).included_modules.should_not
+          include(Amp::Core::RepositoryLoading::ClassMethods)
+    end
+
+    it "includes the new class with InstanceMethods when called" do
+      @class_with.included_modules.should
+          include(Amp::Core::RepositoryLoading::InstanceMethods)
+    end
+
+    it "doesn't include the new class with InstanceMethods when not called" do
+      @class_without.included_modules.should_not
+          include(Amp::Core::RepositoryLoading::InstanceMethods)
+    end
+    
+    it "doesn't ever modify Amp::Command::Base" do
+      Amp::Command::Base.included_modules.should_not
+          include(Amp::Core::RepositoryLoading)
+      Amp::Command::Base.included_modules.should_not
+          include(Amp::Core::RepositoryLoading::InstanceMethods)
+      (class << Amp::Command::Base; self; end).included_modules.should_not
+          include(Amp::Core::RepositoryLoading::ClassMethods)
+    end
+    
+    it "adds a :repository option when called" do
+      opts = @class_with.options
+      repo_opt = opts.find {|name, desc, config| name == :repository }
+      repo_opt.should_not be_nil
+    end
+    
+    it "lacks a :repository option when not called" do
+      opts = @class_without.options
+      repo_opt = opts.find {|name, desc, config| name == :repository }
+      repo_opt.should be_nil
+    end
+  end
+end