librarianp 0.1.2

data/lib/librarian/ui.rb

@@ -0,0 +1,64 @@
+require 'rubygems/user_interaction'
+
+module Librarian
+  class UI
+    def warn(message = nil)
+    end
+
+    def debug(message = nil)
+    end
+
+    def error(message = nil)
+    end
+
+    def info(message = nil)
+    end
+
+    def confirm(message = nil)
+    end
+
+    class Shell < UI
+      attr_writer :shell
+      attr_reader :debug_line_numbers
+
+      def initialize(shell)
+        @shell = shell
+        @quiet = false
+        @debug = ENV['DEBUG']
+        @debug_line_numbers = false
+      end
+
+      def debug(message = nil)
+        @shell.say(message || yield) if @debug && !@quiet
+      end
+
+      def info(message = nil)
+        @shell.say(message || yield) if !@quiet
+      end
+
+      def confirm(message = nil)
+        @shell.say(message || yield, :green) if !@quiet
+      end
+
+      def warn(message = nil)
+        @shell.say(message || yield, :yellow)
+      end
+
+      def error(message = nil)
+        @shell.say(message || yield, :red)
+      end
+
+      def be_quiet!
+        @quiet = true
+      end
+
+      def debug!
+        @debug = true
+      end
+
+      def debug_line_numbers!
+        @debug_line_numbers = true
+      end
+    end
+  end
+end

data/lib/librarian/version.rb

@@ -0,0 +1,3 @@
+module Librarian
+  VERSION = File.read(File.expand_path("../../../VERSION", __FILE__)).strip
+end

data/lib/librarian.rb

@@ -0,0 +1,11 @@
+require 'librarian/version'
+require 'librarian/environment'
+
+module Librarian
+  extend self
+
+  def environment_class
+    self::Environment
+  end
+
+end

data/librarian.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+# stub: librarianp 0.1.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "librarianp"
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Jay Feldblum", "Carlos Sanchez"]
+  s.date = "2015-02-24"
+  s.description = "A Framework for Bundlers, used by librarian-puppet."
+  s.email = ["y_feldblum@yahoo.com", "carlos@apache.org"]
+  s.files = [".gitignore", ".rspec", ".travis.yml", "CHANGELOG.md", "Gemfile", "Gemfile.lock", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/librarian.rb", "lib/librarian/action.rb", "lib/librarian/action/base.rb", "lib/librarian/action/clean.rb", "lib/librarian/action/ensure.rb", "lib/librarian/action/install.rb", "lib/librarian/action/persist_resolution_mixin.rb", "lib/librarian/action/resolve.rb", "lib/librarian/action/update.rb", "lib/librarian/algorithms.rb", "lib/librarian/cli.rb", "lib/librarian/cli/manifest_presenter.rb", "lib/librarian/config.rb", "lib/librarian/config/database.rb", "lib/librarian/config/file_source.rb", "lib/librarian/config/hash_source.rb", "lib/librarian/config/source.rb", "lib/librarian/dependency.rb", "lib/librarian/dsl.rb", "lib/librarian/dsl/receiver.rb", "lib/librarian/dsl/target.rb", "lib/librarian/environment.rb", "lib/librarian/environment/runtime_cache.rb", "lib/librarian/error.rb", "lib/librarian/helpers.rb", "lib/librarian/linter/source_linter.rb", "lib/librarian/lockfile.rb", "lib/librarian/lockfile/compiler.rb", "lib/librarian/lockfile/parser.rb", "lib/librarian/logger.rb", "lib/librarian/manifest.rb", "lib/librarian/manifest_set.rb", "lib/librarian/mock.rb", "lib/librarian/mock/cli.rb", "lib/librarian/mock/dsl.rb", "lib/librarian/mock/environment.rb", "lib/librarian/mock/extension.rb", "lib/librarian/mock/source.rb", "lib/librarian/mock/source/mock.rb", "lib/librarian/mock/source/mock/registry.rb", "lib/librarian/mock/version.rb", "lib/librarian/posix.rb", "lib/librarian/resolution.rb", "lib/librarian/resolver.rb", "lib/librarian/resolver/implementation.rb", "lib/librarian/rspec/support/cli_macro.rb", "lib/librarian/source.rb", "lib/librarian/source/basic_api.rb", "lib/librarian/source/git.rb", "lib/librarian/source/git/repository.rb", "lib/librarian/source/local.rb", "lib/librarian/source/path.rb", "lib/librarian/spec.rb", "lib/librarian/spec_change_set.rb", "lib/librarian/specfile.rb", "lib/librarian/support/abstract_method.rb", "lib/librarian/ui.rb", "lib/librarian/version.rb", "librarian.gemspec", "spec/functional/cli_spec.rb", "spec/functional/posix_spec.rb", "spec/functional/source/git/repository_spec.rb", "spec/functional/source/git_spec.rb", "spec/support/fakefs.rb", "spec/support/method_patch_macro.rb", "spec/support/project_path_macro.rb", "spec/support/with_env_macro.rb", "spec/unit/action/base_spec.rb", "spec/unit/action/clean_spec.rb", "spec/unit/action/ensure_spec.rb", "spec/unit/action/install_spec.rb", "spec/unit/algorithms_spec.rb", "spec/unit/config/database_spec.rb", "spec/unit/dependency/requirement_spec.rb", "spec/unit/dependency_spec.rb", "spec/unit/dsl_spec.rb", "spec/unit/environment/runtime_cache_spec.rb", "spec/unit/environment_spec.rb", "spec/unit/lockfile/parser_spec.rb", "spec/unit/lockfile_spec.rb", "spec/unit/manifest/version_spec.rb", "spec/unit/manifest_set_spec.rb", "spec/unit/manifest_spec.rb", "spec/unit/mock/environment_spec.rb", "spec/unit/mock/source/mock_spec.rb", "spec/unit/resolver_spec.rb", "spec/unit/source/git_spec.rb", "spec/unit/spec_change_set_spec.rb"]
+  s.homepage = "https://github.com/carlossg/librarian"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.3"
+  s.summary = "A Framework for Bundlers."
+  s.test_files = ["spec/functional/cli_spec.rb", "spec/functional/posix_spec.rb", "spec/functional/source/git/repository_spec.rb", "spec/functional/source/git_spec.rb", "spec/support/fakefs.rb", "spec/support/method_patch_macro.rb", "spec/support/project_path_macro.rb", "spec/support/with_env_macro.rb", "spec/unit/action/base_spec.rb", "spec/unit/action/clean_spec.rb", "spec/unit/action/ensure_spec.rb", "spec/unit/action/install_spec.rb", "spec/unit/algorithms_spec.rb", "spec/unit/config/database_spec.rb", "spec/unit/dependency/requirement_spec.rb", "spec/unit/dependency_spec.rb", "spec/unit/dsl_spec.rb", "spec/unit/environment/runtime_cache_spec.rb", "spec/unit/environment_spec.rb", "spec/unit/lockfile/parser_spec.rb", "spec/unit/lockfile_spec.rb", "spec/unit/manifest/version_spec.rb", "spec/unit/manifest_set_spec.rb", "spec/unit/manifest_spec.rb", "spec/unit/mock/environment_spec.rb", "spec/unit/mock/source/mock_spec.rb", "spec/unit/resolver_spec.rb", "spec/unit/source/git_spec.rb", "spec/unit/spec_change_set_spec.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<thor>, ["~> 0.15"])
+      s.add_runtime_dependency(%q<highline>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, ["~> 0.4.2"])
+    else
+      s.add_dependency(%q<thor>, ["~> 0.15"])
+      s.add_dependency(%q<highline>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<fakefs>, ["~> 0.4.2"])
+    end
+  else
+    s.add_dependency(%q<thor>, ["~> 0.15"])
+    s.add_dependency(%q<highline>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.14"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<fakefs>, ["~> 0.4.2"])
+  end
+end

data/spec/functional/cli_spec.rb

@@ -0,0 +1,27 @@
+require "securerandom"
+
+require "librarian/rspec/support/cli_macro"
+
+require "librarian/mock/cli"
+
+module Librarian
+  module Mock
+    describe Cli do
+      include Librarian::RSpec::Support::CliMacro
+
+      describe "version" do
+        before do
+          cli! "version"
+        end
+
+        it "should print the version" do
+          expect(stdout).to eq strip_heredoc(<<-STDOUT)
+            librarian-#{Librarian::VERSION}
+            librarian-mock-#{Librarian::Mock::VERSION}
+          STDOUT
+        end
+      end
+
+    end
+  end
+end

data/spec/functional/posix_spec.rb

@@ -0,0 +1,32 @@
+require "librarian/posix"
+
+require "support/project_path_macro"
+
+describe Librarian::Posix do
+  include Support::ProjectPathMacro
+
+  let(:tmp_path) { project_path + "tmp/spec/functional/posix" }
+  after { tmp_path.rmtree if tmp_path && tmp_path.exist? }
+
+  describe ".run!" do
+
+    it "returns the stdout" do
+      res = described_class.run!(%w[echo hello there]).strip
+      expect(res).to eq "hello there"
+    end
+
+    it "changes directory" do
+      tmp_path.mkpath
+      res = described_class.run!(%w[pwd], :chdir => tmp_path).strip
+      expect(res).to eq tmp_path.to_s
+    end
+
+    it "reads the env" do
+      res = described_class.run!(%w[env], :env => {"KOALA" => "BEAR"})
+      line = res.lines.find{|l| l.start_with?("KOALA=")}.strip
+      expect(line).to eq "KOALA=BEAR"
+    end
+
+  end
+
+end

data/spec/functional/source/git/repository_spec.rb

@@ -0,0 +1,199 @@
+require "fileutils"
+require "pathname"
+require "securerandom"
+
+require "librarian/posix"
+
+require "librarian/source/git/repository"
+
+require "librarian/mock/environment"
+
+require "support/project_path_macro"
+
+describe Librarian::Source::Git::Repository do
+  include Support::ProjectPathMacro
+
+  let(:env) { Librarian::Mock::Environment.new }
+
+  let(:tmp_path) { project_path + "tmp/spec/functional/source/git/repository" }
+  after { tmp_path.rmtree if tmp_path && tmp_path.exist? }
+  let(:git_source_path) { tmp_path + SecureRandom.hex(16) }
+  let(:branch) { "the-branch" }
+  let(:tag) { "the-tag" }
+  let(:atag) { "the-atag" }
+
+  def cmd!(command)
+    Librarian::Posix.run! command
+  end
+
+  def git!(command)
+    cmd!([described_class.bin] + command)
+  end
+
+  before do
+    git_source_path.mkpath
+    Dir.chdir(git_source_path) do
+      git! %W[init]
+      git! %W[config user.name Simba]
+      git! %W[config user.email simba@savannah-pride.gov]
+
+      # master
+      FileUtils.touch "butter.txt"
+      git! %W[add butter.txt]
+      git! %W[commit -m #{"Initial Commit"}]
+
+      # branch
+      git! %W[checkout -b #{branch} --quiet]
+      FileUtils.touch "jam.txt"
+      git! %W[add jam.txt]
+      git! %W[commit -m #{"Branch Commit"}]
+      git! %W[checkout master --quiet]
+
+      # tag/atag
+      git! %W[checkout -b deletable --quiet]
+      FileUtils.touch "jelly.txt"
+      git! %W[add jelly.txt]
+      git! %W[commit -m #{"Tag Commit"}]
+      git! %W[tag #{tag}]
+      git! %W[tag -am #{"Annotated Tag Commit"} #{atag}]
+      git! %W[checkout master --quiet]
+      git! %W[branch -D deletable]
+    end
+  end
+
+  describe ".bin" do
+    specify { expect(described_class.bin).to_not be_empty }
+  end
+
+  describe ".git_version" do
+    specify { expect(described_class.git_version).to match( /^\d+(\.\d+)+$/ ) }
+  end
+
+  context "the original" do
+    subject { described_class.new(env, git_source_path) }
+
+    it "should recognize it" do
+      expect(subject).to be_git
+    end
+
+    it "should not list any remotes for it" do
+      expect(subject.remote_names).to be_empty
+    end
+
+    it "should not list any remote branches for it" do
+      expect(subject.remote_branch_names).to be_empty
+    end
+
+    it "should have divergent shas for master, branch, tag, and atag" do
+      revs = %W[ master #{branch} #{tag} #{atag} ]
+      rev_parse = proc{|rev| git!(%W[rev-parse #{rev} --quiet]).strip}
+      shas = Dir.chdir(git_source_path){revs.map(&rev_parse)}
+      expect(shas.map(&:class).uniq).to eq [String]
+      expect(shas.map(&:size).uniq).to eq [40]
+      expect(shas.uniq).to eq shas
+    end
+  end
+
+  context "a clone" do
+    let(:git_clone_path) { tmp_path + SecureRandom.hex(16) }
+    subject { described_class.clone!(env, git_clone_path, git_source_path) }
+
+    let(:master_sha) { subject.hash_from("origin", "master") }
+    let(:branch_sha) { subject.hash_from("origin", branch) }
+    let(:tag_sha) { subject.hash_from("origin", tag) }
+    let(:atag_sha) { subject.hash_from("origin", atag) }
+
+    it "should recognize it" do
+      expect(subject).to be_git
+    end
+
+    it "should have a single remote for it" do
+      expect(subject).to have(1).remote_names
+    end
+
+    it "should have a remote with the expected name" do
+      expect(subject.remote_names.first).to eq "origin"
+    end
+
+    it "should have the remote branch" do
+      expect(subject.remote_branch_names["origin"]).to include branch
+    end
+
+    it "should be checked out on the master" do
+      expect(subject).to be_checked_out(master_sha)
+    end
+
+    context "checking for commits" do
+      it "has the master commit" do
+        expect(subject).to have_commit(master_sha)
+      end
+
+      it "has the branch commit" do
+        expect(subject).to have_commit(branch_sha)
+      end
+
+      it "has the tag commit" do
+        expect(subject).to have_commit(tag_sha)
+      end
+
+      it "has the atag commit" do
+        expect(subject).to have_commit(atag_sha)
+      end
+
+      it "does not have a made-up commit" do
+        expect(subject).to_not have_commit(SecureRandom.hex(20))
+      end
+
+      it "does not have a tree commit" do
+        master_tree_sha = Dir.chdir(git_source_path) do
+          git!(%W[log -1 --no-color --format=tformat:%T master]).strip
+        end
+        expect(master_tree_sha).to match(/\A[0-9a-f]{40}\z/) # sanity
+        expect(subject).to_not have_commit(master_tree_sha)
+      end
+    end
+
+    context "checking out the branch" do
+      before do
+        subject.checkout! branch
+      end
+
+      it "should be checked out on the branch" do
+        expect(subject).to be_checked_out(branch_sha)
+      end
+
+      it "should not be checked out on the master" do
+        expect(subject).to_not be_checked_out(master_sha)
+      end
+    end
+
+    context "checking out the tag" do
+      before do
+        subject.checkout! tag
+      end
+
+      it "should be checked out on the tag" do
+        expect(subject).to be_checked_out(tag_sha)
+      end
+
+      it "should not be checked out on the master" do
+        expect(subject).to_not be_checked_out(master_sha)
+      end
+    end
+
+    context "checking out the annotated tag" do
+      before do
+        subject.checkout! atag
+      end
+
+      it "should be checked out on the annotated tag" do
+        expect(subject).to be_checked_out(atag_sha)
+      end
+
+      it "should not be checked out on the master" do
+        expect(subject).to_not be_checked_out(master_sha)
+      end
+    end
+  end
+
+end

data/spec/functional/source/git_spec.rb

@@ -0,0 +1,174 @@
+require "fileutils"
+require "pathname"
+require "securerandom"
+
+require "librarian/error"
+require "librarian/posix"
+require "librarian/source/git"
+require "librarian/source/git/repository"
+require "librarian/mock/environment"
+
+require "support/project_path_macro"
+
+describe Librarian::Source::Git do
+  include Support::ProjectPathMacro
+
+  let(:tmp_path) { project_path + "tmp/spec/functional/source/git" }
+  after { tmp_path.rmtree if tmp_path && tmp_path.exist? }
+  let(:env_project_path) { tmp_path + "project" }
+
+  def cmd!(command)
+    Librarian::Posix.run! command
+  end
+
+  def git!(command)
+    cmd!([Librarian::Source::Git::Repository.bin] + command)
+  end
+
+  def new_env
+    Librarian::Mock::Environment.new(:project_path => env_project_path)
+  end
+
+  context "when the remote is bad" do
+    let(:remote) { tmp_path.join(SecureRandom.hex(8)).to_s }
+    let(:env) { new_env }
+    let(:source) { described_class.new(env, remote, {}) }
+
+    it "fails when caching" do
+      expect { source.cache! }.to raise_error Librarian::Error,
+        /^fatal: repository .+ does not exist$/ # from git
+    end
+  end
+
+  context "when the remote has a repo" do
+    let(:remote) { tmp_path.join(SecureRandom.hex(8)).to_s }
+    let(:git_source_path) { Pathname.new(remote) }
+    let(:env) { new_env }
+    let(:source) { described_class.new(env, remote, {}) }
+
+    before do
+      git_source_path.mkpath
+      Dir.chdir(git_source_path) do
+        git! %W[init]
+        git! %W[config user.name Simba]
+        git! %W[config user.email simba@savannah-pride.gov]
+        FileUtils.touch "butter.txt"
+        git! %W[add butter.txt]
+        git! %W[commit -m #{"Initial Commit"}]
+      end
+    end
+
+    let(:sha) do
+      Dir.chdir(git_source_path) do
+        git!(%W[rev-parse master]).strip
+      end
+    end
+
+    context "when caching once" do
+      it "has the expected sha" do
+        expect{source.cache!}.to change{source.sha}.from(nil).to(sha)
+      end
+
+      it "records the history" do
+        expect{source.cache!}.to change{source.git_ops_count}.from(0).to(9)
+      end
+    end
+
+    context "when caching twice" do
+      before { source.cache! }
+
+      it "keeps the expected sha" do
+        expect{source.cache!}.to_not change{source.sha}
+      end
+
+      it "runs git commands once" do
+        expect{source.cache!}.to_not change{source.git_ops_count}
+      end
+    end
+
+    context "when caching twice from different sources" do
+      let(:other_source) { described_class.new(env, remote, {}) }
+      before { other_source.cache! }
+
+      it "has the expected sha" do
+        expect{source.cache!}.to change{source.sha}.from(nil).to(sha)
+      end
+
+      it "records the history" do
+        expect{source.cache!}.to change{source.git_ops_count}.from(0).to(1)
+      end
+    end
+
+    context "when caching twice from different sources, second time with sha" do
+      let(:other_source) { described_class.new(env, remote, {}) }
+      before { other_source.cache! }
+
+      let(:source) { described_class.new(env, remote, {:sha => sha}) }
+
+      it "has the expected sha" do
+        expect{source.cache!}.to_not change{source.sha}
+      end
+
+      it "records the history" do
+        expect{source.cache!}.to change{source.git_ops_count}.from(0).to(1)
+      end
+    end
+
+    context "when caching twice from different environments" do
+      let(:other_source) { described_class.new(new_env, remote, {}) }
+      before { other_source.cache! }
+
+      it "has the expected sha" do
+        expect{source.cache!}.to change{source.sha}.from(nil).to(sha)
+      end
+
+      it "records the history" do
+        expect{source.cache!}.to change{source.git_ops_count}.from(0).to(8)
+      end
+    end
+
+    context "when caching twice from different environments, second time with sha" do
+      let(:other_source) { described_class.new(new_env, remote, {}) }
+      before { other_source.cache! }
+
+      let(:source) { described_class.new(env, remote, {:sha => sha}) }
+
+      it "has the expected sha" do
+        expect{source.cache!}.to_not change{source.sha}
+      end
+
+      it "records the history" do
+        expect{source.cache!}.to change{source.git_ops_count}.from(0).to(3)
+      end
+    end
+
+    context "when the sha is missing from a cached repo" do
+      let(:other_source) { described_class.new(new_env, remote, {}) }
+      before { other_source.cache! }
+
+      before do
+        Dir.chdir(git_source_path) do
+          FileUtils.touch "jam.txt"
+          git! %w[add jam.txt]
+          git! %W[commit -m #{"Some Jam"}]
+        end
+      end
+
+      let(:source) { described_class.new(env, remote, {:sha => sha}) }
+
+      it "has a new remote sha" do
+        expect(sha).to_not eq(other_source.sha)
+      end
+
+      it "has the expected sha" do
+        expect{source.cache!}.to_not change{source.sha}
+      end
+
+      it "records the history" do
+        expect{source.cache!}.to change{source.git_ops_count}.from(0).to(8)
+      end
+    end
+
+  end
+
+end

data/spec/support/fakefs.rb

@@ -0,0 +1,37 @@
+require "fakefs/safe"
+require "fakefs/spec_helpers"
+require "support/method_patch_macro"
+
+if defined?(Rubinius)
+  module Rubinius
+    class CodeLoader
+      class << self
+        alias_method :require_fakefs_original, :require
+        def require(s)
+          ::FakeFS.without { require_fakefs_original(s) }
+        end
+      end
+    end
+  end
+end
+
+module Support
+  module FakeFS
+
+    def self.included(base)
+      base.module_exec do
+        include ::FakeFS::SpecHelpers
+      end
+
+      # Since ruby-1.9.3-p286, Kernel#Pathname was changed in a way that broke
+      # FakeFS's assumptions. It used to lookup the Pathname constant (which is
+      # where FakeFS hooks) and send it #new, but now it keeps a reference to
+      # the Pathname constant (breaking the FakeFS hook).
+      base.module_exec do
+        include MethodPatchMacro
+        with_module_method(Kernel, :Pathname){|s| Pathname.new(s)}
+      end
+    end
+
+  end
+end

data/spec/support/method_patch_macro.rb

@@ -0,0 +1,30 @@
+require "securerandom"
+
+module Support
+  module MethodPatchMacro
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def with_module_method(mod, meth, &block)
+        tag = SecureRandom.hex(8)
+        orig_meth = "_#{tag}_#{meth}".to_sym
+        before do
+          mod.module_eval do
+            alias_method orig_meth, meth
+            define_method meth, &block
+          end
+        end
+        after do
+          mod.module_eval do
+            alias_method meth, orig_meth
+            remove_method orig_meth
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/support/project_path_macro.rb

@@ -0,0 +1,14 @@
+module Support
+  module ProjectPathMacro
+
+    project_path = Pathname.new(__FILE__).expand_path
+    project_path = project_path.dirname until project_path.join("Rakefile").exist?
+
+    PROJECT_PATH = project_path
+
+    def project_path
+      PROJECT_PATH
+    end
+
+  end
+end

data/spec/support/with_env_macro.rb

@@ -0,0 +1,22 @@
+module Support
+  module WithEnvMacro
+
+    module ClassMethods
+
+      def with_env(new)
+        old = Hash[new.map{|k, v| [k, ENV[k]]}]
+
+        before { ENV.update(new) }
+        after  { ENV.update(old) }
+      end
+
+    end
+
+    private
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+  end
+end