amp-core 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.hg*
+*.gemspec

data/Gemfile

@@ -0,0 +1,11 @@
+# This is an install-only file - it's not used by the application
+source "http://rubygems.org"
+
+gem 'amp-front'
+
+group :development do
+  gem 'jeweler'
+  gem 'rspec', '< 2.0.0'
+  gem 'yard'
+  gem 'cucumber'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Edgar
+
+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,17 @@
+= amp-core
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Michael Edgar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "amp-core"
+    gem.summary = %Q{The core plugin for Amp. Necessary for Amp to function.}
+    gem.description = <<-EOF
+Amp's required plugin, providing core functionality (such as repository detection
+and amp-specific command validations) to all other plugins.
+EOF
+    gem.email = "michael.j.edgar@dartmouth.edu"
+    gem.homepage = "http://github.com/michaeledgar/amp-core"
+    gem.authors = ["Michael Edgar"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => [:spec, :test]
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/features/amp-core.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'amp-core'
+
+require 'spec/expectations'

data/lib/amp-core.rb

@@ -0,0 +1,53 @@
+module Amp
+  module Core
+  end
+  module Support
+  end
+end
+
+class Amp::Plugins::Core < Amp::Plugins::Base
+  # this is necessary to prevent loading when #load! isn't called.
+  @loader = lambda {
+    $:.unshift(File.expand_path(File.dirname(__FILE__)))
+    module ::Amp
+      module Core
+        module Repositories
+          autoload :GenericRepoPicker,         'amp-core/repository/generic_repo_picker.rb'
+          autoload :AbstractLocalRepository,   'amp-core/repository/abstract/abstract_local_repo.rb'
+          autoload :AbstractStagingArea,       'amp-core/repository/abstract/abstract_staging_area.rb'
+          autoload :AbstractChangeset,         'amp-core/repository/abstract/abstract_changeset.rb'
+          autoload :AbstractVersionedFile,     'amp-core/repository/abstract/abstract_versioned_file.rb'
+          autoload :CommonChangesetMethods,    'amp-core/repository/abstract/common_methods/changeset.rb'
+          autoload :CommonLocalRepoMethods,    'amp-core/repository/abstract/common_methods/local_repo.rb'
+          autoload :CommonStagingAreaMethods,  'amp-core/repository/abstract/common_methods/staging_area.rb'
+          autoload :CommonChangesetMethods,    'amp-core/repository/abstract/common_methods/changeset.rb'
+          autoload :CommonVersionedFileMethods,'amp-core/repository/abstract/common_methods/versioned_file.rb'
+        end
+        module Support
+          autoload :EncodingUtils,  'amp-core/support/encoding_utils.rb'
+          autoload :Platform,       'amp-core/support/platform_utils.rb'
+          autoload :RootedOpener,   'amp-core/support/rooted_opener.rb'
+          autoload :StringUtils,    'amp-core/support/string_utils.rb'
+        end
+      end
+    end
+  }
+  class << self
+    attr_reader :loader
+  end
+
+  def initialize(opts={})
+    @opts = opts
+  end
+  
+  def load!
+    puts "Loading amp-core..."
+    require 'amp-core/command_ext/repository_loading'
+    require 'amp-core/repository/repository.rb'
+    require 'amp-core/repository/generic_repo_picker.rb'
+    ::Amp::Support.class_eval do
+      autoload :Template,                  "amp-core/templates/template.rb"
+    end
+    self.class.loader.call
+  end
+end

data/lib/amp-core/command_ext/repository_loading.rb

@@ -0,0 +1,31 @@
+module Amp
+  module Core
+    module RepositoryLoading
+      def self.included(klass)
+        klass.__send__(:extend, ClassMethods)
+        klass.__send__(:include, InstanceMethods)
+      end
+      module ClassMethods
+
+      end
+      module InstanceMethods
+        DEFAULT_OPTS = {:create => false}
+        def repository(repo_opts=DEFAULT_OPTS)
+          repo_opts = DEFAULT_OPTS.merge(repo_opts)
+          path = options[:repository]
+          # pick a repo based on this
+          return Repositories.pick(options, path, repo_opts[:create])
+        end
+      end
+    end
+  end
+
+  module Command
+    class Base
+      def self.has_repo
+        include Core::RepositoryLoading
+        opt :repository, "The path to the repository to use", :short => "-R", :default => Dir.pwd
+      end
+    end
+  end
+end

data/lib/amp-core/repository/abstract/abstract_changeset.rb

@@ -0,0 +1,113 @@
+##################################################################
+#                  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 Core
+    module Repositories
+      class AbstractChangeset
+        include CommonChangesetMethods
+        include Enumerable
+        include Comparable
+      
+        ##
+        # the nodes that this node inherits from
+        # 
+        # @return [Array<Abstract Changeset>]
+        def parents
+          raise NotImplementedError.new("parents() must be implemented by subclasses of AbstractChangeset.")
+        end
+      
+        ##
+        # Iterates over every tracked file in this changeset.
+        # 
+        # @return [AbstractChangeset] self
+        def each
+          raise NotImplementedError.new("each() must be implemented by subclasses of AbstractChangeset.")
+        end
+      
+        ##
+        # How does this changeset compare to +other+? Used in sorting.
+        # 
+        # @param [AbstractChangeset] other
+        # @return [Integer] -1, 0, or 1
+        def <=>(other)
+          raise NotImplementedError.new("<=>() must be implemented by subclasses of AbstractChangeset.")
+        end
+
+        ##
+        # Retrieve +filename+
+        #
+        # @return [AbstractVersionedFile]
+        def get_file(filename)
+          raise NotImplementedError.new("get_file() must be implemented by subclasses of AbstractChangeset.")
+        end
+        alias_method :[], :get_file
+
+        ##
+        # When was the changeset made?
+        # 
+        # @return [Time]
+        def date
+          raise NotImplementedError.new("date() must be implemented by subclasses of AbstractChangeset.")
+        end
+
+        ##
+        # The user who made the changeset
+        # 
+        # @return [String] the user who made the changeset
+        def user
+          raise NotImplementedError.new("user() must be implemented by subclasses of AbstractChangeset.")
+        end
+      
+        ##
+        # Which branch this changeset belongs to
+        # 
+        # @return [String] the user who made the changeset
+        def branch
+          raise NotImplementedError.new("branch() must be implemented by subclasses of AbstractChangeset.")
+        end
+
+        ##
+        # @return [String]
+        def description
+          raise NotImplementedError.new("description() must be implemented by subclasses of AbstractChangeset.")
+        end
+      
+        ##
+        # What files have been altered in this changeset?
+        # 
+        # @return [Array<String>]
+        def altered_files
+          raise NotImplementedError.new("altered_files() must be implemented by subclasses of AbstractChangeset.")
+        end
+      
+        ##
+        # Returns a list of all files that are tracked at this current revision.
+        #
+        # @return [Array<String>] the files tracked at the given revision
+        def all_files
+          raise NotImplementedError.new("all_files() must be implemented by subclasses of AbstractChangeset.")
+        end
+      
+        # Is this changeset a working changeset?
+        #
+        # @return [Boolean] is the changeset representing the working directory?
+        def working?
+          raise NotImplementedError.new("working() must be implemented by subclasses of AbstractChangeset.")
+        end
+      
+      end
+    end
+  end
+end

data/lib/amp-core/repository/abstract/abstract_local_repo.rb

@@ -0,0 +1,208 @@
+##################################################################
+#                  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 Core
+    module Repositories
+      ##
+      # This class contains the functionality of all repositories ever.
+      # Methods here rely on certain base methods that are unimplemented,
+      # left as an exercise for the reader.
+
+      class AbstractLocalRepository
+        include CommonLocalRepoMethods
+      
+        ##
+        # Returns the root of the repository (not the .hg/.git root)
+        #
+        # @return [String]
+        def root
+          raise NotImplementedError.new("root() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+      
+        ##
+        # Returns the staging area for the repository, which provides the ability to add/remove
+        # files in the next commit.
+        #
+        # @return [AbstractStagingArea]
+        def staging_area
+          raise NotImplementedError.new("staging_area() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+      
+        ##
+        # Has the file been modified from node1 to node2?
+        # 
+        # @param [String] file the file to check
+        # @param [Hash] opts needs to have :node1 and :node2
+        # @return [Boolean] has the +file+ been modified?
+        def file_modified?(file, opts={})
+          raise NotImplementedError.new("file_modified?() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+      
+        ##
+        # Write +text+ to +filename+, where +filename+
+        # is local to the root.
+        #
+        # @param [String] filename The file as relative to the root
+        # @param [String] text The text to write to said file
+        def working_write(filename, text)
+          raise NotImplementedError.new("working_write() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+      
+        ##
+        # Commits a changeset or set of files to the repository. You will quite often
+        # use this method since it's basically the basis of version control systems.
+        #
+        # @api
+        # @param [Hash] opts the options to this method are all optional, so it's a very
+        #   flexible method. Options listed below.
+        # @option opts [Array] :modified ([]) which files have been added or modified
+        #   that you want to be added as a changeset.
+        # @option opts [Array] :removed ([]) which files should be removed in this
+        #   commit?
+        # @option opts [Hash] :extra ({}) any extra data, such as "close" => true
+        #   will close the active branch.
+        # @option opts [String] :message ("") the message for the commit. An editor
+        #   will be opened if this is not provided.
+        # @option opts [Boolean] :force (false) Forces the commit, ignoring minor details
+        #   like when you try to commit when no files have been changed.
+        # @option opts [Match] :match (nil) A match object to specify how to pick files
+        #   to commit. These are useful so you don't accidentally commit ignored files,
+        #   for example.
+        # @option opts [Array<String>] :parents (nil) the node IDs of the parents under
+        #   which this changeset will be committed. No more than 2 for mercurial.
+        # @option opts [Boolean] :empty_ok (false) Is an empty commit message a-ok?
+        # @option opts [Boolean] :force_editor (false) Do we force the editor to be
+        #   opened, even if :message is provided?
+        # @option opts [String] :user (ENV["HGUSER"]) the username to associate with the commit.
+        #   Defaults to AmpConfig#username.
+        # @option opts [DateTime, Time, Date] :date (Time.now) the date to mark with
+        #   the commit. Useful if you miss a deadline and want to pretend that you actually
+        #   made it!
+        # @return [String] the digest referring to this entry in the changelog
+        def commit(opts={})
+          raise NotImplementedError.new("commit() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+  
+        ##
+        # Pushes changesets to a remote repository.
+        #
+        # @param [Repository] remote_repo the remote repository object to push to
+        # @param [Hash] options extra options for pushing
+        # @option options [Boolean] :force (false) Force pushing, even if it would create
+        #   new heads (or some other error arises)
+        # @option options [Array<Fixnum, String>] :revs ([]) specify which revisions to push
+        # @return [Boolean] for success/failure
+        def push(remote_repo, options = {})
+          raise NotImplementedError.new("push() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+
+        ##
+        # Pulls changesets from a remote repository 
+        # Does *not* apply them to the working directory.
+        #
+        # @param [Repository] remote_repo the remote repository object to pull from
+        # @param [Hash] options extra options for pulling
+        # @option options [Array<String, Fixnum>] :heads ([]) which repository heads to pull, such as
+        #   a branch name or a sha-1 identifier
+        # @option options [Boolean] :force (false) force the pull, ignoring any errors or warnings
+        # @return [Boolean] for success/failure
+        def pull(remote_repo, options = {})
+          raise NotImplementedError.new("pull() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+  
+        ##
+        # Returns a changeset for the given revision.
+        # Must support at least integer indexing as well as a string "node ID", if the repository
+        # system has such IDs. Also "tip" should return the tip of the revision tree.
+        #
+        # @return [AbstractChangeset]
+        def [](revision)
+          raise NotImplementedError.new("[]() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+  
+        ##
+        # Returns the number of changesets in the repository.
+        #
+        # @return [Fixnum]
+        def size
+          raise NotImplementedError.new("size() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+  
+        ##
+        # Gets a given file at the given revision, in the form of an AbstractVersionedFile object.
+        #
+        # @return [AbstractVersionedFile]
+        def get_file(file, revision)
+          raise NotImplementedError.new("get_file() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+  
+        ##
+        # In whatever conflict-resolution system your repository format defines, mark a given file
+        # as in conflict. If your format does not manage conflict resolution, re-define this method as
+        # a no-op.
+        #
+        # @return [Boolean]
+        def mark_conflicted(*filenames)
+          raise NotImplementedError.new("mark_conflicted() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+  
+        ##
+        # In whatever conflict-resolution system your repository format defines, mark a given file
+        # as no longer in conflict (resolved). If your format does not manage conflict resolution,
+        # re-define this method as a no-op.
+        #
+        # @return [Boolean]
+        def mark_resolved(*filenames)
+          raise NotImplementedError.new("mark_resolved() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+      
+        ##
+        # Attempts to resolve the given file, according to how mercurial manages
+        # merges. Needed for api compliance.
+        #
+        # @api
+        # @param [String] filename the file to attempt to resolve
+        def try_resolve_conflict(filename)
+          raise NotImplementedError.new("try_resolve_conflict() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+      
+        ##
+        # Returns all files that have not been merged. In other words, if we're 
+        # waiting for the user to fix up their merge, then return the list of files
+        # we need to be correct before merging.
+        #
+        # @todo think up a better name
+        #
+        # @return [Array<Array<String, Symbol>>] an array of String-Symbol pairs - the
+        #   filename is the first entry, the status of the merge is the second.
+        def uncommitted_merge_files
+          raise NotImplementedError.new("uncommitted_merge_files() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+      
+        ##
+        # Regarding branch support.
+        #
+        # For each repository format, you begin in a default branch.  Each repo format, of
+        # course, starts with a different default branch.  Mercurial's is "default", Git's is "master".
+        #
+        # @api
+        # @return [String] the default branch name
+        def default_branch_name
+          raise NotImplementedError.new("default_branch_name() must be implemented by subclasses of AbstractLocalRepository.")
+        end
+      end
+    end
+  end
+end