halite 1.0.0.rc.1 → 1.0.0

data/lib/halite/converter.rb

@@ -1,17 +1,41 @@
-require 'halite/converter/libraries'
-require 'halite/converter/metadata'
-require 'halite/converter/other'
-require 'halite/converter/readme'
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 
 module Halite
+  # (see Converter.write)
   module Converter
+    autoload :Chef, 'halite/converter/chef'
+    autoload :Libraries, 'halite/converter/libraries'
+    autoload :Metadata, 'halite/converter/metadata'
+    autoload :Misc, 'halite/converter/misc'
 
-    def self.write(spec, base_path)
-      Metadata.write(spec, base_path)
-      Libraries.write(spec, base_path)
-      Other.write(spec, base_path)
-      Readme.write(spec, base_path)
+    # Convert a cookbook gem to a normal Chef cookbook.
+    #
+    # @since 1.0.0
+    # @param gem_data [Halite::Gem] Gem to convert.
+    # @param output_path [String] Output path.
+    # @return [void]
+    # @example
+    #   Halite::Converter.write(Halite::Gem.new(gemspec), 'dest')
+    def self.write(gem_data, output_path)
+      Chef.write(gem_data, output_path)
+      Libraries.write(gem_data, output_path)
+      Metadata.write(gem_data, output_path)
+      Misc.write(gem_data, output_path)
     end
-
   end
 end

data/lib/halite/converter/chef.rb

@@ -0,0 +1,43 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'fileutils'
+
+
+module Halite
+  module Converter
+    # Converter module for cookbook-specific files. These are copied verbatim
+    # from the chef/ directory in the gem.
+    #
+    # @since 1.0.0
+    # @api private
+    module Chef
+      # Copy all files in the chef/ directory in the gem.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @param output_path [String] Output path for the cookbook.
+      # @return [void]
+      def self.write(gem_data, output_path)
+        gem_data.each_file('chef') do |path, rel_path|
+          dir_path = File.dirname(rel_path)
+          FileUtils.mkdir_p(File.join(output_path, dir_path)) unless dir_path == '.'
+          FileUtils.copy(path, File.join(output_path, rel_path), preserve: true)
+        end
+      end
+
+    end
+  end
+end

data/lib/halite/converter/libraries.rb

@@ -1,40 +1,107 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'fileutils'
+
+
 module Halite
   module Converter
+    # Converter methods for gem library code (ex. files under lib/).
+    #
+    # @since 1.0.0
+    # @api private
     module Libraries
-
-      # Chef doesn't allow subfolders under libraries/ currently
-      def self.flatten_filename(path)
-        path.gsub(/\//, '__')
+      # Generate the bootstrap code for the Chef cookbook.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @param entry_points [Array<String>] Zero or more entry points to be
+      #   automatically loaded.
+      # @return [String]
+      def self.generate_bootstrap(gem_data, entry_points)
+        ''.tap do |buf|
+          buf << gem_data.license_header
+          buf << <<-EOH
+raise 'Halite is not compatible with no_lazy_load false, please set no_lazy_load true in your Chef configuration file.' unless Chef::Config[:no_lazy_load]
+$LOAD_PATH << File.expand_path('../../files/halite_gem', __FILE__)
+EOH
+          entry_points.each do |entry_point|
+            buf << "require #{entry_point.inspect}\n"
+          end
+        end
       end
 
-      def self.generate(spec, data, entry_point=false)
-        # No newline on the header so that line numbers in the files aren't changed.
-        buf = (entry_point ? "ENV['HALITE_LOAD'] = '1'; begin; " : "if ENV['HALITE_LOAD']; ")
-        # Rewrite requires to require_relative as needed.
-        data = data.gsub(/require ['"](#{spec.name}[^'"]*)['"]/) { "require_relative '#{flatten_filename($1)}'" }
-        spec.cookbook_dependencies.each do |dep|
-          next unless dep.type == :dependencies
-          # This is kind of gross, but not sure what else to do
-          data = data.gsub(/require ['"](#{dep.name}[^'"]*)['"]/) { "require_relative '../../#{dep.name}/libraries/#{flatten_filename($1)}'" }
+      # Copy all library code to the files/halite_gem/ directory in the cookbook.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @param output_path [String] Output path for the cookbook.
+      # @return [void]
+      def self.write_libraries(gem_data, output_path)
+        dest_path = File.join(output_path, 'files', 'halite_gem')
+        FileUtils.mkdir_p(dest_path)
+        gem_data.each_library_file do |path, rel_path|
+          dir_path = File.dirname(rel_path)
+          FileUtils.mkdir_p(File.join(dest_path, dir_path)) unless dir_path == '.'
+          FileUtils.copy(path, File.join(dest_path, rel_path), preserve: true)
         end
-        buf << data.rstrip
-        # Match up with the header. All files get one line longer. ¯\_(ツ)_/¯
-        buf << (entry_point ? "\nensure; ENV.delete('HALITE_LOAD'); end\n" : "\nend\n")
-        buf
       end
 
-      def self.write(spec, base_path, entry_point_name=nil)
-        entry_point_name ||= spec.name
-        # Handle both cases, with .rb and without
-        entry_point_name += '.rb' unless entry_point_name.end_with?('.rb')
-        lib_path = File.join(base_path, 'libraries')
-        # Create cookbook's libraries folder
-        Dir.mkdir(lib_path) unless File.directory?(lib_path)
-        spec.each_library_file do |path, rel_path|
-          IO.write(File.join(lib_path, flatten_filename(rel_path)), generate(spec, IO.read(path), entry_point_name == rel_path))
+      # Find any default entry points (files name cheftie.rb) in the gem.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @return [Array<String>]
+      def self.find_default_entry_points(gem_data)
+        [].tap do |entry_points|
+          gem_data.each_library_file do |_path, rel_path|
+            if File.basename(rel_path) == 'cheftie.rb'
+              # Trim the .rb for cleanliness.
+              entry_points << rel_path[0..-4]
+            end
+          end
         end
       end
 
+      # Create the bootstrap code in the cookbook.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @param output_path [String] Output path for the cookbook.
+      # @param entry_point [String, Array<String>] Entry point(s) for the
+      #   bootstrap. These are require paths that will be loaded automatically
+      #   during a Chef converge.
+      # @return [void]
+      def self.write_bootstrap(gem_data, output_path, entry_point=nil)
+        # Default entry point.
+        entry_point ||= gem_data.spec.metadata['halite_entry_point'] || find_default_entry_points(gem_data)
+        # Parse and cast.
+        entry_point = Array(entry_point).map {|s| s.split }.flatten
+        # Write bootstrap file.
+        lib_path = File.join(output_path, 'libraries')
+        FileUtils.mkdir_p(lib_path)
+        IO.write(File.join(lib_path, 'default.rb'), generate_bootstrap(gem_data, entry_point))
+      end
+
+      # Write out the library code for the cookbook.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @param output_path [String] Output path for the cookbook.
+      # @return [void]
+      def self.write(gem_data, output_path, entry_point=nil)
+        write_libraries(gem_data, output_path)
+        write_bootstrap(gem_data, output_path, entry_point)
+      end
+
     end
   end
 end

data/lib/halite/converter/metadata.rb

@@ -1,19 +1,57 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
 module Halite
   module Converter
+    # Converter module to create the metadata.rb for the cookbook.
+    #
+    # @since 1.0.0
+    # @api private
     module Metadata
-
-      def self.generate(spec)
-        buf = spec.license_header
-        buf << "name #{spec.cookbook_name.inspect}\n"
-        buf << "version #{spec.version.inspect}\n"
-        spec.cookbook_dependencies.each do |dep|
-          buf << "depends #{dep.name.inspect}, #{dep.requirement.inspect}\n"
+      # Generate a cookbook metadata file.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @return [String]
+      def self.generate(gem_data)
+        ''.tap do |buf|
+          buf << gem_data.license_header
+          buf << "name #{gem_data.cookbook_name.inspect}\n"
+          buf << "version #{gem_data.version.inspect}\n"
+          if gem_data.spec.description && !gem_data.spec.description.empty?
+            buf << "description #{gem_data.spec.description.inspect}\n"
+          end
+          if readme_path = gem_data.find_misc_path('Readme') # rubocop:disable Lint/AssignmentInCondition
+            buf << "long_description #{IO.read(readme_path).inspect}\n"
+          end
+          gem_data.cookbook_dependencies.each do |dep|
+            buf << "depends #{dep.name.inspect}"
+            buf << ", #{dep.requirement.inspect}" if dep.requirement != '>= 0'
+            buf << "\n"
+          end
         end
-        buf
       end
 
-      def self.write(spec, base_path)
-        IO.write(File.join(base_path, 'metadata.rb'), generate(spec))
+      # Write out a cookbook metadata file.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @param output_path [String] Output path for the cookbook.
+      # @return [void]
+      def self.write(gem_data, output_path)
+        IO.write(File.join(output_path, 'metadata.rb'), generate(gem_data))
       end
 
     end

data/lib/halite/converter/misc.rb

@@ -0,0 +1,43 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'fileutils'
+
+
+module Halite
+  module Converter
+    # Converter module for miscellanous project-level files like README.md
+    # and LICENSE.txt.
+    #
+    # @since 1.0.0
+    # @api private
+    module Misc
+      # Copy miscellaneous project-level files.
+      #
+      # @param gem_data [Halite::Gem] Gem to generate from.
+      # @param output_path [String] Output path for the cookbook.
+      # @return [void]
+      def self.write(gem_data, output_path)
+        %w{Readme License Copying Contributing}.each do |name|
+          if path = gem_data.find_misc_path(name) # rubocop:disable Lint/AssignmentInCondition
+            FileUtils.copy(path, File.join(output_path, File.basename(path)), preserve: true)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/halite/dependencies.rb

@@ -1,10 +1,43 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 require 'halite/error'
 
+
 module Halite
+  # Error class for invalid dependencies.
+  #
+  # @since 1.0.0
+  class InvalidDependencyError < Error; end
+
+  # Methods to extract cookbook dependencies from a gem.
+  #
+  # @since 1.0.0
   module Dependencies
-    class InvalidDependencyError < Error; end
+    Dependency = Struct.new(:name, :requirement, :type, :spec) do
+      def ==(other)
+        self.name == other.name && \
+        self.requirement == other.requirement && \
+        self.type == other.type
+      end
 
-    Dependency = Struct.new(:name, :requirement, :type)
+      def cookbook
+        Gem.new(spec) if spec
+      end
+    end
 
     def self.extract(spec)
       deps = []
@@ -28,29 +61,35 @@ module Halite
     def self.extract_from_dependencies(spec)
       # Find any gem dependencies that are cookbooks in disguise.
       spec.dependencies.select do |dep|
-        Gem.new(dep).is_halite_cookbook?
+        dep.type == :runtime && Gem.new(dep).is_halite_cookbook?
       end.map do |dep|
-        [Gem.new(dep).cookbook_name] + dep.requirements_list
+        gem = Gem.new(dep)
+        [gem.cookbook_name] + dep.requirements_list + [gem.spec]
       end
     end
 
     def self.clean_and_tag(deps, tag)
       deps.map do |dep|
         dep = clean(dep)
-        Dependency.new(dep[0], dep[1], tag)
+        Dependency.new(dep[0], dep[1], tag, dep[2])
       end
     end
 
-
     def self.clean(dep)
-      # Convert to an array of strings
-      dep = Array(dep).map {|obj| obj.to_s.strip }
+      # Convert to an array of strings, remove the spec to be re-added later.
+      dep = Array(dep)
+      spec = if dep.last.is_a?(::Gem::Specification)
+        dep.pop
+      end
+      dep = Array(dep).map {|obj| obj.is_a?(::Gem::Specification) ? obj : obj.to_s.strip }
       # Unpack single strings like 'foo >= 1.0'
       dep = dep.first.split(/\s+/, 2) if dep.length == 1
       # Default version constraint to match rubygems behavior when sourcing from simple strings
       dep << '>= 0' if dep.length == 1
       raise InvalidDependencyError.new("Chef only supports a single version constraint on each dependency: #{dep}") if dep.length > 2 # ಠ_ಠ
       dep[1] = clean_requirement(dep[1])
+      # Re-add the spec
+      dep << spec if spec
       dep
     end
 
@@ -66,6 +105,7 @@ module Halite
       raise InvalidDependencyError.new("Chef only supports two or three version segments: #{ver}") if segments.length < 1 || segments.length > 3
       segments.each {|s| raise InvalidDependencyError.new("Chef does not support pre-release version numbers: #{ver}") unless s.is_a?(Integer) }
       segments << 0 if segments.length == 1
+      segments = [0] if segments.all? {|s| s == 0 }
       ::Gem::Version.new(segments.join('.'))
     end
   end

data/lib/halite/error.rb

@@ -1,4 +1,24 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
 module Halite
+  # Base class for Halite library errors.
+  #
+  # @since 1.0.0
   class Error < ::Exception
   end
 end