poise-ruby 2.0.0

data/lib/poise_ruby/resources/ruby_gem.rb

@@ -0,0 +1,118 @@
+#
+# 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 'chef/provider/package/rubygems'
+require 'chef/resource/gem_package'
+require 'poise'
+
+require 'poise_ruby/ruby_command_mixin'
+
+
+module PoiseRuby
+  module Resources
+    # (see RubyGem::Resource)
+    # @since 2.0.0
+    module RubyGem
+      # A `ruby_gem` resource to install Ruby gems.
+      #
+      # @provides ruby_gem
+      # @action install
+      # @action upgrade
+      # @action remove
+      # @action purge
+      # @action reconfig
+      # @example
+      #   ruby_gem 'rack'
+      class Resource < Chef::Resource::GemPackage
+        include Poise
+        provides(:ruby_gem)
+        include PoiseRuby::RubyCommandMixin
+
+        # @api private
+        def initialize(name, run_context=nil)
+          super
+          @resource_name = :ruby_gem if @resource_name
+          # Remove when all useful versions are using provider resolver.
+          @provider = PoiseRuby::Resources::RubyGem::Provider if @provider
+        end
+      end
+
+      # The default provider for `ruby_gem`.
+      #
+      # @see Resource
+      # @provides ruby_gem
+      class Provider < Chef::Provider::Package::Rubygems
+        include Poise
+        provides(:ruby_gem)
+
+        def load_current_resource
+          patch_environment { super }
+        end
+
+        def define_resource_requirements
+          patch_environment { super }
+        end
+
+        def action_install
+          patch_environment { super }
+        end
+
+        def action_upgrade
+          patch_environment { super }
+        end
+
+        def action_remove
+          patch_environment { super }
+        end
+
+        def action_purge
+          patch_environment { super }
+        end
+
+        def action_reconfig
+          patch_environment { super }
+        end
+
+        private
+
+        def patch_environment(&block)
+          environment_to_add = if new_resource.parent_ruby
+            new_resource.parent_ruby.ruby_environment
+          else
+            {}
+          end
+
+          begin
+            old_vars = environment_to_add.inject({}) do |memo, (key, value)|
+              memo[key] = ENV[key]
+              ENV[key] = value
+              memo
+            end
+            block.call
+          ensure
+            old_vars.each do |key, value|
+              if value.nil?
+                ENV.delete(key)
+              else
+                ENV[key] = value
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/poise_ruby/resources/ruby_runtime.rb

@@ -0,0 +1,87 @@
+#
+# 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 'chef/resource'
+require 'poise'
+
+
+module PoiseRuby
+  module Resources
+    # (see RubyRuntime::Resource)
+    # @since 2.0.0
+    module RubyRuntime
+      # A `ruby_runtime` resource to manage Ruby installations.
+      #
+      # @provides ruby_runtime
+      # @action install
+      # @action uninstall
+      # @example
+      #   ruby_runtime '2.1.2'
+      class Resource < Chef::Resource
+        include Poise(inversion: true, container: true)
+        provides(:ruby_runtime)
+        actions(:install, :uninstall)
+
+        # @!attribute version
+        #   Version of Ruby to install.
+        #   @return [String]
+        attribute(:version, kind_of: String, name_attribute: true)
+        # @!attribute bundler_version
+        #   Version of Bundler to install. It set to `true`, the latest
+        #   available version will be used. If set to `false`, Bundler will
+        #   not be installed.
+        #   @note Disabling the Bundler install may result in other resources
+        #     being non-functional.
+        #   @return [String, Boolean]
+        attribute(:bundler_version, kind_of: [String, TrueClass, FalseClass], default: true)
+
+        # The path to the `ruby` binary for this Ruby installation. This is an
+        # output property.
+        #
+        # @return [String]
+        # @example
+        #   execute "#{resources('ruby_runtime[2.2.2]').ruby_binary} myapp.rb"
+        def ruby_binary
+          @ruby_binary ||= provider_for_action(:ruby_binary).ruby_binary
+        end
+
+        # The environment variables for this Ruby installation. This is an
+        # output property.
+        #
+        # @return [Hash<String, String>]
+        # @example
+        #   execute '/opt/myapp.py' do
+        #     environment resources('ruby_runtime[2.2.2]').ruby_environment
+        #   end
+        def ruby_environment
+          @ruby_environment ||= provider_for_action(:ruby_environment).ruby_environment
+        end
+
+        # The path to the `gem` binary for this Ruby installation. This is an
+        # output property.
+        #
+        # @return [String]
+        # @example
+        #   execute "#{resources('ruby_runtime[2.2.2]').gem_binary} install myapp"
+        def gem_binary
+          @gem_binary ||= provider_for_action(:gem_binary).gem_binary
+        end
+      end
+
+      # Providers can be found under lib/poise_ruby/ruby_providers/
+    end
+  end
+end

data/lib/poise_ruby/ruby_command_mixin.rb

@@ -0,0 +1,59 @@
+#
+# 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 'poise/utils'
+require 'poise_languages'
+
+
+module PoiseRuby
+  # Mixin for resources and providers which run Ruby commands.
+  #
+  # @since 1.0.0
+  module RubyCommandMixin
+    include Poise::Utils::ResourceProviderMixin
+
+    module Resource
+      include PoiseLanguages::Command::Mixin::Resource(:ruby)
+
+      # @!attribute gem_binary
+      #   Path to the gem binary.
+      #   @return [String]
+      attribute(:gem_binary, kind_of: String, default: lazy { default_gem_binary })
+
+      private
+
+      # Find the default gem binary. If there is a parent use that, otherwise
+      # use the same logic as {PoiseRuby::RubyProviders::Base#gem_binary}.
+      #
+      # @return [String]
+      def default_gem_binary
+        if parent_ruby
+          parent_ruby.gem_binary
+        else
+          dir, base = ::File.split(ruby)
+          # If this ruby is called something weird, bail out.
+          raise NotImplementedError unless base.start_with?('ruby')
+          # Allow for names like "ruby2.0" -> "gem2.0".
+          ::File.join(dir, base.sub(/^ruby/, 'gem'))
+        end
+      end
+    end
+
+    module Provider
+      include PoiseLanguages::Command::Mixin::Provider(:ruby)
+    end
+  end
+end

data/lib/poise_ruby/ruby_providers.rb

@@ -0,0 +1,32 @@
+#
+# 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 'poise_ruby/ruby_providers/chef'
+require 'poise_ruby/ruby_providers/scl'
+require 'poise_ruby/ruby_providers/system'
+
+
+module PoiseRuby
+  # Inversion providers for the ruby_runtime resource.
+  #
+  # @since 2.0.0
+  module RubyProviders
+    Chef::Platform::ProviderPriorityMap.instance.priority(:ruby_runtime, [
+      PoiseRuby::RubyProviders::Scl,
+      PoiseRuby::RubyProviders::System,
+    ])
+  end
+end

data/lib/poise_ruby/ruby_providers/base.rb

@@ -0,0 +1,116 @@
+#
+# 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 'chef/provider'
+require 'poise'
+
+require 'poise_ruby/resources/ruby_runtime'
+
+
+module PoiseRuby
+  module RubyProviders
+    class Base < Chef::Provider
+      include Poise(inversion: :ruby_runtime)
+
+      # Set default inversion options.
+      #
+      # @api private
+      def self.default_inversion_options(node, new_resource)
+        super.merge({
+          bundler_version: new_resource.bundler_version,
+          version: new_resource.version,
+        })
+      end
+
+      # The `install` action for the `ruby_runtime` resource.
+      #
+      # @return [void]
+      def action_install
+        notifying_block do
+          install_ruby
+          install_bundler
+        end
+      end
+
+      # The `uninstall` action for the `ruby_runtime` resource.
+      #
+      # @return [void]
+      def action_uninstall
+        notifying_block do
+          uninstall_ruby
+        end
+      end
+
+      # The path to the `ruby` binary.
+      #
+      # @abstract
+      # @return [String]
+      def ruby_binary
+        raise NotImplementedError
+      end
+
+      # Output property for environment variables.
+      #
+      # @return [Hash<String, String>]
+      def ruby_environment
+        # No environment variables needed. Rejoice.
+        {}
+      end
+
+      # The path to the `gem` binary. Look relative to the
+      # `ruby` binary for a default implementation.
+      #
+      # @return [String]
+      def gem_binary
+        dir, base = ::File.split(ruby_binary)
+        # If this ruby is called something weird, bail out.
+        raise NotImplementedError unless base.start_with?('ruby')
+        # Allow for names like "ruby2.0" -> "gem2.0".
+        ::File.join(dir, base.sub(/^ruby/, 'gem'))
+      end
+
+      private
+
+      # Install the Ruby runtime. Must be implemented by subclass.
+      #
+      # @abstract
+      # @return [void]
+      def install_ruby
+      end
+
+      # Uninstall the Ruby runtime. Must be implemented by subclass.
+      #
+      # @abstract
+      # @return [void]
+      def uninstall_ruby
+      end
+
+      # Install Bundler in to the Ruby runtime.
+      #
+      # @return [void]
+      def install_bundler
+        # Captured because #options conflicts with Chef::Resource::Package#options.
+        bundler_version = options[:bundler_version]
+        return unless bundler_version
+        ruby_gem 'bundler' do
+          action :upgrade if bundler_version == true
+          parent_ruby new_resource
+          version bundler_version if bundler_version.is_a?(String)
+        end
+      end
+    end
+  end
+end

data/lib/poise_ruby/ruby_providers/chef.rb

@@ -0,0 +1,53 @@
+#
+# 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 'poise_ruby/error'
+require 'poise_ruby/ruby_providers/base'
+
+
+module PoiseRuby
+  module RubyProviders
+    # Inversion provider for the `ruby` resource to use whatever Ruby is
+    # currently running, generally Chef's omnibus-d Ruby.
+    #
+    # @since 2.0.0
+    # @provides chef
+    class ChefRuby < Base
+      provides(:chef)
+
+      # The `install` action for the `ruby_runtime` resource.
+      #
+      # @return [void]
+      def action_install
+        # No-op, already installed!
+      end
+
+      # The `uninstall` action for the `ruby_runtime` resource.
+      #
+      # @return [void]
+      def action_uninstall
+        raise PoiseRuby::Error.new("You cannot uninstall Chef's Ruby.")
+      end
+
+      # The path to the running Ruby binary as determined via RbConfig.
+      #
+      # @return [String]
+      def ruby_binary
+        Gem.ruby
+      end
+    end
+  end
+end