librarian 0.0.23 → 0.0.24

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## 0.0.24
+
+* \#15. A remembered configuration system.
+
+* \#16. Configure, and remember configuration for, chef install paths.
+
+* \#38. Configure, and remember configuration for, stripping out `.git`
+  directories from git-sources chef dependencies.
+
+* \#76. Support git annotated tags.
+
+* \#80. Ignore directories in the `PATH` named `git` when looking for the `git`
+  bin.
+
+* \#85. Provide a helpful message when running the `show` command without a
+  lockfile present.
+
 ## 0.0.23
 
 * \#41. Build gems with a built gemspec.

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in librarian.gemspec
 gemspec
+
+gem "fakefs", :require => "fakefs/safe"

data/README.md

@@ -12,33 +12,49 @@ A bundler written with Librarian will expect you to provide a specfile listing
 your project's declared dependencies, including any version constraints and
 including the upstream sources for finding them. Librarian can resolve the spec,
 write a lockfile listing the full resolution, fetch the resolved dependencies,
-install them, and isolate them in your project. This is what Bundler does for
-projects that depend on Ruby gems.
+install them, and isolate them in your project.
+
+A bundler written with Librarian will be similar in kind to [Bundler](http://gembundler.com),
+the bundler for Ruby gems that many modern Rails applications use.
 
 Librarian-Chef
 ---------------
 
+Librarian-Chef is a tool that helps you manage the cookbooks that your chef-repo
+depends on. Here are some more details.
+
 Librarian-Chef is a bundler for infrastructure repositories using Chef. You can
-use Librarian-Chef to resolve your infrastructure's cookbook dependencies,
-fetch them and install them into your infrastructure.
+use Librarian-Chef to resolve your infrastructure's cookbook dependencies, fetch
+them, and install them into your infrastructure repository.
+
+Librarian-Chef can resolve and fetch third-party, publicly-released cookbooks,
+and install them into your infrastructure repository. It can also source
+cookbooks directly from their own source control repositories.
+
+Librarian-Chef can also deal with cookbooks you may actively be working on
+outside your infrastructure repository. For example, it can deal with cookbooks
+directly from their own private source control repositories, whether they are
+remote or local to your machine, and it can deal with cookbooks released to and
+hosted on a private cookbooks server.
 
-Librarian-Chef is for resolving and fetching third-party, publicly-released
-cookbooks, and installing them into your infrastructure repository. It is not
-for dealing with the cookbooks you're actively working on within your
-infrastructure repository.
+Librarian-Chef is not primarily intended for dealing with the cookbooks you are
+actively working on *within* your infrastructure repository. In such a case, you
+can still use Librarian-Chef, but it is likely unnecessary.
 
 Librarian-Chef *takes over* your `cookbooks/` directory and manages it for you
 based on your `Cheffile`. Your `Cheffile` becomes the authoritative source for
 the cookbooks your infrastructure repository depends on. You should not modify
 the contents of your `cookbooks/` directory when using Librarian-Chef. If you
-have custom cookbooks which are specific to your infrastructure repository,
-they should go in your `site-cookbooks/` directory.
+have cookbooks which are, rather than being separate projects, inherently part
+of your infrastructure repository, then they should go in a separate directory,
+like your `site-cookbooks/` directory, and you do not need to use Librarian-Chef
+to manage them.
 
 ### The Cheffile
 
 Every infrastruture repository that uses Librarian-Chef will have a file named
 `Cheffile` in the root directory of that repository. The full specification for
-which third-party, publicly-rleased cookbooks your infrastructure repository
+which third-party, publicly-released cookbooks your infrastructure repository
 depends will go here.
 
 Here's an example `Cheffile`:
@@ -103,7 +119,7 @@ most recent version of the cookbook from that same branch.
 
 The Git source also supports a `:path =>` option. If we use the path option,
 Librarian-Chef will navigate down into the Git repository and only use the
-specified subdirectory. Many people have the havit of having a single repository
+specified subdirectory. Many people have the habit of having a single repository
 with many cookbooks in it. If we need a cookbook from such a repository, we can
 use the `:path =>` option here to help Librarian-Chef drill down and find the
 cookbook subdirectory.
@@ -240,6 +256,75 @@ Upload the cookbooks to your chef-server:
 
     $ knife cookbook upload --all
 
+### Configuration
+
+Configuration comes from three sources with the following highest-to-lowest
+precedence:
+
+* The local config (`./.librarian/chef/config`)
+* The environment
+* The global config (`~/.librarian/chef/config`)
+
+You can inspect the final configuration with:
+
+    $ librarian-chef config
+
+You can find out where a particular key is set with:
+
+    $ librarian-chef config KEY
+
+You can set a key at the global level with:
+
+    $ librarian-chef config KEY VALUE --global
+
+And remove it with:
+
+    $ librarian-chef config KEY --global --delete
+
+You can set a key at the local level with:
+
+    $ librarian-chef config KEY VALUE --local
+
+And remove it with:
+
+    $ librarian-chef config KEY --local --delete
+
+You cannot set or delete environment-level config keys with the CLI.
+
+Configuration set at either the global or local level will affect subsequent
+invocations of `librarian-chef`. Configurations set at the environment level are
+not saved and will not affect subsequent invocations of `librarian-chef`.
+
+You can pass a config at the environment level by taking the original config key
+and transforming it: replace hyphens (`-`) with underscores (`_`) and periods
+(`.`) with doubled underscores (`__`), uppercase, and finally prefix with
+`LIBRARIAN_CHEF_`. For example, to pass a config in the environment for the key
+`part-one.part-two`, set the environment variable
+`LIBRARIAN_CHEF_PART_ONE__PART_TWO`.
+
+Configuration affects how various commands operate.
+
+* The `path` config sets the cookbooks directory to install to. If a relative
+  path, it is relative to the directory containing the `Cheffile`. The
+  equivalent environment variable is `LIBRARIAN_CHEF_PATH`.
+
+* The `install.strip-dot-git` config causes the `.git/` directory to be stripped
+  out when installing cookbooks from a git source. This must be set to exactly
+  "1" to cause this behavior. The equivalent environment variable is
+  `LIBRARIAN_CHEF_INSTALL__STRIP_DOT_GIT`.
+
+Configuration can be set by passing specific options to other commands.
+
+* The `path` config can be set at the local level by passing the `--path` option
+  to the `install` command. It can be unset at the local level by passing the
+  `--no-path` option to the `install` command. Note that if this is set at the
+  environment or global level then, even if `--no-path` is given as an option,
+  the environment or global config will be used.
+
+* The `install.strip-dot-git` config can be set at the local level by passing
+  the `--strip-dot-git` option to the `install` command. It can be unset at the
+  local level by passing the `--no-strip-dot-git` option.
+
 ### Knife Integration
 
 You can integrate your `knife.rb` with Librarian-Chef.

data/features/chef/cli/init.feature

@@ -4,6 +4,7 @@ Feature: cli/init
 
   Scenario: Initing a directory
     When I run `librarian-chef init`
+    Then the exit status should be 0
     Then a file named "Cheffile" should exist
 
 

data/features/chef/cli/show.feature

@@ -25,6 +25,18 @@ Feature: cli/show
 
 
 
+  Scenario: Showing al without a lockfile
+    Given I remove the file "Cheffile.lock"
+    When  I run `librarian-chef show`
+    Then  the exit status should be 1
+    Then  the output should contain exactly:
+      """
+      Be sure to install first!
+
+      """
+
+
+
   Scenario: Showing all
     When I run `librarian-chef show`
     Then the exit status should be 0

data/lib/librarian/chef/cli.rb

@@ -22,6 +22,26 @@ module Librarian
         copy_file environment.specfile_name
       end
 
+      desc "install", "Resolves and installs all of the dependencies you specify."
+      option "verbose", :type => :boolean, :default => false
+      option "line-numbers", :type => :boolean, :default => false
+      option "clean", :type => :boolean, :default => false
+      option "strip-dot-git", :type => :boolean
+      option "path", :type => :string
+      def install
+        ensure!
+        clean! if options["clean"]
+        if options.include?("strip-dot-git")
+          strip_dot_git_val = options["strip-dot-git"] ? "1" : nil
+          environment.config_db.local["install.strip-dot-git"] = strip_dot_git_val
+        end
+        if options.include?("path")
+          environment.config_db.local["path"] = options["path"]
+        end
+        resolve!
+        install!
+      end
+
     end
   end
 end

data/lib/librarian/chef/environment.rb

@@ -11,7 +11,15 @@ module Librarian
       end
 
       def install_path
-        project_path.join("cookbooks")
+        part = config_db["path"] || "cookbooks"
+        project_path.join(part)
+      end
+
+      def config_keys
+        super + %w[
+          install.strip-dot-git
+          path
+        ]
       end
 
     end

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

@@ -6,6 +6,19 @@ module Librarian
     module Source
       class Git < Librarian::Source::Git
         include Local
+
+      private
+
+        def install_perform_step_copy!(found_path, install_path)
+          debug { "Copying #{relative_path_to(found_path)} to #{relative_path_to(install_path)}" }
+          FileUtils.cp_r(found_path, install_path)
+
+          if environment.config_db["install.strip-dot-git"] == "1"
+            dot_git = install_path.join(".git")
+            dot_git.rmtree if dot_git.directory?
+          end
+        end
+
       end
     end
   end

data/lib/librarian/chef/source/local.rb

@@ -19,8 +19,7 @@ module Librarian
             install_path.rmtree
           end
 
-          debug { "Copying #{relative_path_to(found_path)} to #{relative_path_to(install_path)}" }
-          FileUtils.cp_r(found_path, install_path)
+          install_perform_step_copy!(found_path, install_path)
         end
 
         def fetch_version(name, extra)
@@ -33,6 +32,11 @@ module Librarian
 
       private
 
+        def install_perform_step_copy!(found_path, install_path)
+          debug { "Copying #{relative_path_to(found_path)} to #{relative_path_to(install_path)}" }
+          FileUtils.cp_r(found_path, install_path)
+        end
+
         def manifest_data(name)
           @manifest_data ||= { }
           @manifest_data[name] ||= fetch_manifest_data(name)

data/lib/librarian/cli.rb

@@ -57,28 +57,49 @@ module Librarian
       say "librarian-#{root_module.version}"
     end
 
+    desc "config", "Show or edit the config."
+    option "verbose", :type => :boolean, :default => false
+    option "line-numbers", :type => :boolean, :default => false
+    option "global", :type => :boolean, :default => false
+    option "local", :type => :boolean, :default => false
+    option "delete", :type => :boolean, :default => false
+    def config(key = nil, value = nil)
+      if key
+        raise Error, "cannot set both value and delete" if value && options["delete"]
+        if options["delete"]
+          raise Error, "must set either global or local" unless options["global"] ^ options["local"]
+          scope = options["global"] ? :global : options["local"] ? :local : nil
+          environment.config_db[key, scope] = nil
+        elsif value
+          raise Error, "must set either global or local" unless options["global"] ^ options["local"]
+          scope = options["global"] ? :global : options["local"] ? :local : nil
+          environment.config_db[key, scope] = value
+        else
+          raise Error, "cannot set both global and local" if options["global"] && options["local"]
+          scope = options["global"] ? :global : options["local"] ? :local : nil
+          if value = environment.config_db[key, scope]
+            prefix = scope ? "#{key} (#{scope})" : key
+            say "#{prefix}: #{value}"
+          end
+        end
+      else
+        environment.config_db.keys.each do |key|
+          say "#{key}: #{environment.config_db[key]}"
+        end
+      end
+    end
+
     desc "clean", "Cleans out the cache and install paths."
-    option "verbose"
-    option "line-numbers"
+    option "verbose", :type => :boolean, :default => false
+    option "line-numbers", :type => :boolean, :default => false
     def clean
       ensure!
       clean!
     end
 
-    desc "install", "Resolves and installs all of the dependencies you specify."
-    option "verbose"
-    option "line-numbers"
-    option "clean"
-    def install
-      ensure!
-      clean! if options["clean"]
-      resolve!
-      install!
-    end
-
     desc "update", "Updates and installs the dependencies you specify."
-    option "verbose"
-    option "line-numbers"
+    option "verbose", :type => :boolean, :default => false
+    option "line-numbers", :type => :boolean, :default => false
     def update(*names)
       ensure!
       if names.empty?
@@ -90,8 +111,8 @@ module Librarian
     end
 
     desc "outdated", "Lists outdated dependencies."
-    option "verbose"
-    option "line-numbers"
+    option "verbose", :type => :boolean, :default => false
+    option "line-numbers", :type => :boolean, :default => false
     def outdated
       ensure!
       resolution = environment.lock
@@ -104,12 +125,16 @@ module Librarian
     end
 
     desc "show", "Shows dependencies"
-    option "verbose"
-    option "line-numbers"
+    option "verbose", :type => :boolean, :default => false
+    option "line-numbers", :type => :boolean, :default => false
     option "detailed", :type => :boolean
     def show(*names)
       ensure!
-      manifest_presenter.present(names, :detailed => options["detailed"])
+      if environment.lockfile_path.file?
+        manifest_presenter.present(names, :detailed => options["detailed"])
+      else
+        raise Error, "Be sure to install first!"
+      end
     end
 
     desc "init", "Initializes the current directory."

data/lib/librarian/config.rb

@@ -0,0 +1,7 @@
+require "librarian/config/database"
+
+module Librarian
+  module Config
+
+  end
+end

data/lib/librarian/config/database.rb

@@ -0,0 +1,205 @@
+require "pathname"
+
+require "librarian/config/file_source"
+require "librarian/config/hash_source"
+
+module Librarian
+  module Config
+    class Database
+
+      class << self
+        def library
+          name.split("::").first.downcase
+        end
+      end
+
+      attr_accessor :adapter_name
+      private :adapter_name=
+
+      attr_accessor :root, :assigned_specfile_name
+      private :root=, :assigned_specfile_name=
+
+      attr_accessor :underlying_env, :underlying_pwd, :underlying_home
+      private :underlying_env=, :underlying_pwd=, :underlying_home=
+
+      def initialize(adapter_name, options = { })
+        self.adapter_name = adapter_name or raise ArgumentError, "must provide adapter_name"
+
+        options[:project_path] || options[:pwd] or raise ArgumentError, "must provide project_path or pwd"
+
+        self.root = options[:project_path] && Pathname(options[:project_path])
+        self.assigned_specfile_name = options[:specfile_name]
+        self.underlying_env = options[:env] or raise ArgumentError, "must provide env"
+        self.underlying_pwd = options[:pwd] && Pathname(options[:pwd])
+        self.underlying_home = options[:home] && Pathname(options[:home])
+      end
+
+      def global
+        memo(__method__) { new_file_source(global_config_path) }
+      end
+
+      def env
+        memo(__method__) { HashSource.new(adapter_name, :name => "environment", :raw => env_source_data) }
+      end
+
+      def local
+        memo(__method__) { new_file_source(local_config_path) }
+      end
+
+      def [](key, scope = nil)
+        case scope
+        when "local", :local then local[key]
+        when "env", :env then env[key]
+        when "global", :global then global[key]
+        when nil then local[key] || env[key] || global[key]
+        else raise Error, "bad scope"
+        end
+      end
+
+      def []=(key, scope, value)
+        case scope
+        when "local", :local then local[key] = value
+        when "global", :global then global[key] = value
+        else raise Error, "bad scope"
+        end
+      end
+
+      def keys
+        [local, env, global].inject([]){|a, e| a.concat(e.keys) ; a}.sort.uniq
+      end
+
+      def project_path
+        root || specfile_path.dirname
+      end
+
+      def specfile_path
+        if root
+          root + (assigned_specfile_name || default_specfile_name)
+        else
+          env_specfile_path || default_specfile_path
+        end
+      end
+
+      def specfile_name
+        specfile_path.basename.to_s
+      end
+
+      def lockfile_path
+        project_path + lockfile_name
+      end
+
+      def lockfile_name
+        "#{specfile_name}.lock"
+      end
+
+    private
+
+      def new_file_source(config_path)
+        return unless config_path
+
+        FileSource.new(adapter_name,
+          :config_path => config_path,
+          :forbidden_keys => [config_key, specfile_key]
+        )
+      end
+
+      def global_config_path
+        env_global_config_path || default_global_config_path
+      end
+
+      def env_global_config_path
+        memo(__method__) { env[config_key] }
+      end
+
+      def default_global_config_path
+        underlying_home && underlying_home + config_name
+      end
+
+      def local_config_path
+        root_local_config_path || env_local_config_path || default_local_config_path
+      end
+
+      def root_local_config_path
+        root && root + config_name
+      end
+
+      def env_specfile_path
+        memo(__method__) do
+          path = env[specfile_key]
+          path && Pathname(path)
+        end
+      end
+
+      def default_specfile_path
+        default_project_root_path + (assigned_specfile_name || default_specfile_name)
+      end
+
+      def env_local_config_path
+        return unless env_specfile_path
+
+        env_specfile_path.dirname + config_name
+      end
+
+      def default_local_config_path
+        default_project_root_path + config_name
+      end
+
+      def default_project_root_path
+        if root
+          root
+        else
+          path = underlying_pwd
+          path = path.dirname until project_root_path?(path) || path.dirname == path
+          project_root_path?(path) ? path : underlying_pwd
+        end
+      end
+
+      def project_root_path?(path)
+        File.file?(path + default_specfile_name)
+      end
+
+      def config_key
+        "config"
+      end
+
+      def specfile_key
+        "#{adapter_name}file"
+      end
+
+      def default_specfile_name
+        "#{adapter_name.capitalize}file"
+      end
+
+      def library
+        self.class.library
+      end
+
+      def config_name_prefix
+        ".#{library}"
+      end
+
+      def config_name
+        File.join(*[config_name_prefix, adapter_name, "config"])
+      end
+
+      def raw_key_prefix
+        "#{library.upcase}_#{adapter_name.upcase}_"
+      end
+
+      def env_source_data
+        prefix = raw_key_prefix
+
+        data = underlying_env.dup
+        data.reject!{|k, _| !k.start_with?(prefix) || k.size <= prefix.size}
+        data
+      end
+
+      def memo(key)
+        key = "@#{key}"
+        instance_variable_set(key, yield) unless instance_variable_defined?(key)
+        instance_variable_get(key)
+      end
+
+    end
+  end
+end