librarian 0.0.23 → 0.0.24

data/lib/librarian/config/file_source.rb

@@ -0,0 +1,47 @@
+require "yaml"
+
+require "librarian/config/source"
+
+module Librarian
+  module Config
+    class FileSource < Source
+
+      attr_accessor :config_path
+      private :config_path=
+
+      def initialize(adapter_name, options = { })
+        super
+
+        self.config_path = options.delete(:config_path) or raise ArgumentError, "must provide config_path"
+      end
+
+      def to_s
+        config_path
+      end
+
+    private
+
+      def load
+        return { } unless File.file?(config_path)
+
+        raw = YAML.load_file(config_path)
+        return { } unless Hash === raw
+
+        translate_raw_to_config(raw)
+      end
+
+      def save(config)
+        raw = translate_config_to_raw(config)
+
+        if config.empty?
+          File.delete(config_path) if File.file?(config_path)
+        else
+          config_dir = File.dirname(config_path)
+          FileUtils.mkpath(config_dir) unless File.directory?(config_dir)
+          File.open(config_path, "wb"){|f| YAML.dump(raw, f)}
+        end
+      end
+
+    end
+  end
+end

data/lib/librarian/config/hash_source.rb

@@ -0,0 +1,33 @@
+require "librarian/source"
+
+module Librarian
+  module Config
+    class HashSource < Source
+
+      attr_accessor :name, :raw
+      private :name=, :raw=
+
+      def initialize(adapter_name, options = { })
+        super
+
+        self.name = options.delete(:name) or raise ArgumentError, "must provide name"
+        self.raw = options.delete(:raw) or raise ArgumentError, "must provide raw"
+      end
+
+      def to_s
+        name
+      end
+
+    private
+
+      def load
+        translate_raw_to_config(raw)
+      end
+
+      def save(config)
+        raise Error, "nonsense!"
+      end
+
+    end
+  end
+end

data/lib/librarian/config/source.rb

@@ -0,0 +1,149 @@
+require "librarian/error"
+
+module Librarian
+  module Config
+    class Source
+
+      RAW_KEY_SUFFIX_VALIDITY_PATTERN =
+        /\A[A-Z0-9_]+\z/
+      CONFIG_KEY_VALIDITY_PATTERN =
+        /\A[a-z][a-z0-9\-]+(?:\.[a-z0-9\-]+)*\z/
+
+      class << self
+        def raw_key_suffix_validity_pattern
+          RAW_KEY_SUFFIX_VALIDITY_PATTERN
+        end
+        def config_key_validity_pattern
+          CONFIG_KEY_VALIDITY_PATTERN
+        end
+      end
+
+      attr_accessor :adapter_name
+      private :adapter_name=
+
+      def initialize(adapter_name, options = { })
+        self.adapter_name = adapter_name
+
+        self.forbidden_keys = options.delete(:forbidden_keys) || []
+      end
+
+      def [](key)
+        load!
+
+        data[key]
+      end
+
+      def []=(key, value)
+        key_permitted?(key) or raise Error, "key not permitted: #{key.inspect}"
+        value_permitted?(key, value) or raise Error, "value for key #{key.inspect} not permitted: #{value.inspect}"
+
+        load!
+        if value.nil?
+          data.delete(key)
+        else
+          data[key] = value
+        end
+        save(data)
+      end
+
+      def keys
+        load!
+
+        data.keys
+      end
+
+    private
+
+      attr_accessor :data, :forbidden_keys
+
+      def load!
+        self.data = load unless data
+      end
+
+      def key_permitted?(key)
+        String === key &&
+        config_key_validity_pattern === key &&
+        !forbidden_keys.any?{|k| k === key}
+      end
+
+      def value_permitted?(key, value)
+        return true if value.nil?
+
+        String === value
+      end
+
+      def raw_key_valid?(key)
+        return false unless key.start_with?(raw_key_prefix)
+
+        suffix = key[raw_key_prefix.size..-1]
+        raw_key_suffix_validity_pattern =~ suffix
+      end
+
+      def raw_key_suffix_validity_pattern
+        self.class.raw_key_suffix_validity_pattern
+      end
+
+      def config_key_valid?(key)
+        config_key_validity_pattern === key
+      end
+
+      def config_key_validity_pattern
+        self.class.config_key_validity_pattern
+      end
+
+      def raw_key_prefix
+        @key_prefix ||= "LIBRARIAN_#{adapter_name.upcase}_"
+      end
+
+      def assert_raw_keys_valid!(raw)
+        bad_keys = raw.keys.reject{|k| raw_key_valid?(k)}
+        unless bad_keys.empty?
+          config_path_s = config_path.to_s.inspect
+          bad_keys_s = bad_keys.map(&:inspect).join(", ")
+          raise Error, "config #{to_s} has bad keys: #{bad_keys_s}"
+        end
+      end
+
+      def assert_config_keys_valid!(config)
+        bad_keys = config.keys.reject{|k| config_key_valid?(k)}
+        unless bad_keys.empty?
+          bad_keys_s = bad_keys.map(&:inspect).join(", ")
+          raise Error, "config has bad keys: #{bad_keys_s}"
+        end
+      end
+
+      def assert_values_valid!(data)
+        bad_data = data.reject{|k, v| String === v}
+        bad_keys = bad_data.keys
+
+        unless bad_keys.empty?
+          bad_keys_s = bad_keys.map(&:inspect).join(", ")
+          raise Error, "config has bad values for keys: #{bad_keys_s}"
+        end
+      end
+
+      def translate_raw_to_config(raw)
+        assert_raw_keys_valid!(raw)
+        assert_values_valid!(raw)
+
+        Hash[raw.map do |key, value|
+          key = key[raw_key_prefix.size .. -1]
+          key = key.downcase.gsub(/__/, ".").gsub(/_/, "-")
+          [key, value]
+        end]
+      end
+
+      def translate_config_to_raw(config)
+        assert_config_keys_valid!(config)
+        assert_values_valid!(config)
+
+        Hash[config.map do |key, value|
+          key = key.gsub(/\./, "__").gsub(/\-/, "_").upcase
+          key = "#{raw_key_prefix}#{key}"
+          [key, value]
+        end]
+      end
+
+    end
+  end
+end

data/lib/librarian/environment.rb

@@ -4,6 +4,7 @@ require "librarian/helpers/debug"
 require "librarian/support/abstract_method"
 
 require "librarian/error"
+require "librarian/config"
 require "librarian/lockfile"
 require "librarian/specfile"
 require "librarian/resolver"
@@ -21,25 +22,25 @@ module Librarian
     abstract_method :specfile_name, :dsl_class, :install_path
 
     def initialize(options = { })
+      @pwd = options.fetch(:pwd) { Dir.pwd }
+      @env = options.fetch(:env) { ENV.to_hash }
+      @home = options.fetch(:home) { File.expand_path("~") }
       @project_path = options[:project_path]
       @specfile_name = options[:specfile_name]
     end
 
-    def project_path
-      @project_path ||= begin
-        root = Pathname.new(Dir.pwd)
-        root = root.dirname until project_path?(root)
-        path = root.join(specfile_name)
-        path.file? ? root : nil
+    def config_db
+      @config_db ||= begin
+        Config::Database.new(adapter_name,
+          :pwd => @pwd,
+          :env => @env,
+          :home => @home,
+          :project_path => @project_path,
+          :specfile_name => default_specfile_name
+        )
       end
     end
 
-    def project_path?(path)
-      path.join(config_name).directory? ||
-      path.join(specfile_name).file? ||
-      path.dirname == path
-    end
-
     def default_specfile_name
       @default_specfile_name ||= begin
         capped = adapter_name.capitalize
@@ -47,12 +48,16 @@ module Librarian
       end
     end
 
+    def project_path
+      config_db.project_path
+    end
+
     def specfile_name
-      @specfile_name ||= default_specfile_name
+      config_db.specfile_name
     end
 
     def specfile_path
-      project_path.join(specfile_name)
+      config_db.specfile_path
     end
 
     def specfile
@@ -63,20 +68,12 @@ module Librarian
       nil
     end
 
-    def config_name
-      File.join(*[config_prefix, adapter_name].compact)
-    end
-
-    def config_prefix
-      ".librarian"
-    end
-
     def lockfile_name
-      "#{specfile_name}.lock"
+      config_db.lockfile_name
     end
 
     def lockfile_path
-      project_path.join(lockfile_name)
+      config_db.lockfile_path
     end
 
     def lockfile
@@ -119,6 +116,11 @@ module Librarian
       self.class.name.split("::")[0 ... -1].inject(Object, &:const_get)::Dsl
     end
 
+    def config_keys
+      %[
+      ]
+    end
+
   private
 
     def environment

data/lib/librarian/source/git/repository.rb

@@ -34,7 +34,7 @@ module Librarian
               path = File.expand_path(path)
               exts.each do |ext|
                 exe = File.join(path, cmd + ext)
-                return exe if File.executable?(exe)
+                return exe if File.file?(exe) && File.executable?(exe)
               end
             end
             nil
@@ -127,7 +127,7 @@ module Librarian
             reference = "#{remote}/#{reference}"
           end
 
-          command = %W(rev-parse #{reference} --quiet)
+          command = %W(rev-list #{reference} -1)
           run!(command, :chdir => true).strip
         end
 

data/lib/librarian/version.rb

@@ -1,3 +1,3 @@
 module Librarian
-  VERSION = "0.0.23"
+  VERSION = "0.0.24"
 end

data/librarian.gemspec

@@ -2,19 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = "librarian"
-  s.version = "0.0.23"
+  s.version = "0.0.24"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Feldblum"]
-  s.date = "2012-05-14"
+  s.date = "2012-06-23"
   s.description = "Librarian"
   s.email = ["y_feldblum@yahoo.com"]
   s.executables = ["librarian-chef", "librarian-mock"]
-  s.files = [".gitignore", ".rspec", ".travis.yml", "CHANGELOG.md", "Gemfile", "MIT-LICENSE", "README.md", "Rakefile", "bin/librarian-chef", "bin/librarian-mock", "config/cucumber.yaml", "features/chef/cli/init.feature", "features/chef/cli/install.feature", "features/chef/cli/show.feature", "features/chef/cli/version.feature", "features/support/env.rb", "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/resolve.rb", "lib/librarian/action/update.rb", "lib/librarian/chef.rb", "lib/librarian/chef/cli.rb", "lib/librarian/chef/dsl.rb", "lib/librarian/chef/environment.rb", "lib/librarian/chef/extension.rb", "lib/librarian/chef/integration/knife.rb", "lib/librarian/chef/manifest_reader.rb", "lib/librarian/chef/source.rb", "lib/librarian/chef/source/git.rb", "lib/librarian/chef/source/local.rb", "lib/librarian/chef/source/path.rb", "lib/librarian/chef/source/site.rb", "lib/librarian/chef/templates/Cheffile", "lib/librarian/cli.rb", "lib/librarian/cli/manifest_presenter.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/error.rb", "lib/librarian/helpers.rb", "lib/librarian/helpers/debug.rb", "lib/librarian/lockfile.rb", "lib/librarian/lockfile/compiler.rb", "lib/librarian/lockfile/parser.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/resolution.rb", "lib/librarian/resolver.rb", "lib/librarian/resolver/implementation.rb", "lib/librarian/source.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/chef/source/git_spec.rb", "spec/functional/chef/source/site_spec.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/dependency_spec.rb", "spec/unit/dsl_spec.rb", "spec/unit/environment_spec.rb", "spec/unit/lockfile/parser_spec.rb", "spec/unit/lockfile_spec.rb", "spec/unit/manifest_set_spec.rb", "spec/unit/manifest_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.files = [".gitignore", ".rspec", ".travis.yml", "CHANGELOG.md", "Gemfile", "MIT-LICENSE", "README.md", "Rakefile", "bin/librarian-chef", "bin/librarian-mock", "config/cucumber.yaml", "features/chef/cli/init.feature", "features/chef/cli/install.feature", "features/chef/cli/show.feature", "features/chef/cli/version.feature", "features/support/env.rb", "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/resolve.rb", "lib/librarian/action/update.rb", "lib/librarian/chef.rb", "lib/librarian/chef/cli.rb", "lib/librarian/chef/dsl.rb", "lib/librarian/chef/environment.rb", "lib/librarian/chef/extension.rb", "lib/librarian/chef/integration/knife.rb", "lib/librarian/chef/manifest_reader.rb", "lib/librarian/chef/source.rb", "lib/librarian/chef/source/git.rb", "lib/librarian/chef/source/local.rb", "lib/librarian/chef/source/path.rb", "lib/librarian/chef/source/site.rb", "lib/librarian/chef/templates/Cheffile", "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/error.rb", "lib/librarian/helpers.rb", "lib/librarian/helpers/debug.rb", "lib/librarian/lockfile.rb", "lib/librarian/lockfile/compiler.rb", "lib/librarian/lockfile/parser.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/resolution.rb", "lib/librarian/resolver.rb", "lib/librarian/resolver/implementation.rb", "lib/librarian/source.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/chef/source/git_spec.rb", "spec/functional/chef/source/site_spec.rb", "spec/functional/source/git/repository_spec.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/config/database_spec.rb", "spec/unit/dependency_spec.rb", "spec/unit/dsl_spec.rb", "spec/unit/environment_spec.rb", "spec/unit/lockfile/parser_spec.rb", "spec/unit/lockfile_spec.rb", "spec/unit/manifest_set_spec.rb", "spec/unit/manifest_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 = ""
   s.require_paths = ["lib"]
   s.rubyforge_project = "librarian"
-  s.rubygems_version = "1.8.17"
+  s.rubygems_version = "1.8.24"
   s.summary = "Librarian"
 
   if s.respond_to? :specification_version then
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<aruba>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, [">= 0"])
       s.add_runtime_dependency(%q<chef>, [">= 0.10"])
       s.add_runtime_dependency(%q<highline>, [">= 0"])
       s.add_runtime_dependency(%q<archive-tar-minitar>, [">= 0.5.2"])
@@ -37,6 +38,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<cucumber>, [">= 0"])
       s.add_dependency(%q<aruba>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<fakefs>, [">= 0"])
       s.add_dependency(%q<chef>, [">= 0.10"])
       s.add_dependency(%q<highline>, [">= 0"])
       s.add_dependency(%q<archive-tar-minitar>, [">= 0.5.2"])
@@ -48,6 +50,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<cucumber>, [">= 0"])
     s.add_dependency(%q<aruba>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<fakefs>, [">= 0"])
     s.add_dependency(%q<chef>, [">= 0.10"])
     s.add_dependency(%q<highline>, [">= 0"])
     s.add_dependency(%q<archive-tar-minitar>, [">= 0.5.2"])

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

@@ -0,0 +1,149 @@
+require "fileutils"
+require "pathname"
+require "securerandom"
+
+require "librarian/source/git/repository"
+
+describe Librarian::Source::Git::Repository do
+
+  let(:env) do
+    double(:ui => nil)
+  end
+
+  let(:project_path) do
+    project_path = Pathname.new(__FILE__).expand_path
+    project_path = project_path.dirname until project_path.join("Rakefile").exist?
+    project_path
+  end
+  let(:tmp_path) { project_path + "tmp/spec/unit/source/git/repository-spec" }
+  let(:git_source_path) { tmp_path + SecureRandom.hex(16) }
+  let(:branch) { "the-branch" }
+  let(:tag) { "the-tag" }
+  let(:atag) { "the-atag" }
+
+  before do
+    git_source_path.mkpath
+    Dir.chdir(git_source_path) do
+      `git init`
+
+      # master
+      `touch butter.txt`
+      `git add butter.txt`
+      `git commit -m "Initial Commit"`
+
+      # branch
+      `git checkout -b #{branch} --quiet`
+      `touch jam.txt`
+      `git add jam.txt`
+      `git commit -m "Branch Commit"`
+      `git checkout master --quiet`
+
+      # tag
+      `git checkout -b deletable --quiet`
+      `touch jelly.txt`
+      `git add jelly.txt`
+      `git commit -m "Tag Commit"`
+      `git tag #{tag}`
+      `git checkout master --quiet`
+      `git branch -D deletable`
+
+      # annotated tag
+      `git checkout -b deletable --quiet`
+      `touch jelly.txt`
+      `git add jelly.txt`
+      `git commit -m "Tag Commit"`
+      `git tag -am "Annotated Tag Commit" #{atag}`
+      `git checkout master --quiet`
+      `git branch -D deletable`
+    end
+  end
+
+  context "the original" do
+    subject { described_class.new(env, git_source_path) }
+
+    it "should recognize it" do
+      subject.should be_git
+    end
+
+    it "should not list any remotes for it" do
+      subject.remote_names.should be_empty
+    end
+
+    it "should not list any remote branches for it" do
+      subject.remote_branch_names.should be_empty
+    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
+      subject.should be_git
+    end
+
+    it "should have a single remote for it" do
+      subject.should have(1).remote_names
+    end
+
+    it "should have a remote with the expected name" do
+      subject.remote_names.first.should == "origin"
+    end
+
+    it "should have the remote branch" do
+      subject.remote_branch_names["origin"].should include branch
+    end
+
+    it "should be checked out on the master" do
+      subject.should be_checked_out(master_sha)
+    end
+
+    context "checking out the branch" do
+      before do
+        subject.checkout! branch
+      end
+
+      it "should be checked out on the branch" do
+        subject.should be_checked_out(branch_sha)
+      end
+
+      it "should not be checked out on the master" do
+        subject.should_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
+        subject.should be_checked_out(tag_sha)
+      end
+
+      it "should not be checked out on the master" do
+        subject.should_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
+        subject.should be_checked_out(atag_sha)
+      end
+
+      it "should not be checked out on the master" do
+        subject.should_not be_checked_out(master_sha)
+      end
+    end
+  end
+
+end