poise-file 1.0.0

data/Rakefile

@@ -0,0 +1,17 @@
+#
+# Copyright 2017, 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_boiler/rakefile'

data/lib/poise_file.rb

@@ -0,0 +1,21 @@
+#
+# Copyright 2017, 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 PoiseFile
+  autoload :Resources, 'poise_file/resources'
+  autoload :VERSION, 'poise_file/version'
+end

data/lib/poise_file/cheftie.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2017, 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_file/resources'

data/lib/poise_file/resources.rb

@@ -0,0 +1,27 @@
+#
+# Copyright 2017, 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_file/resources/poise_file'
+
+
+module PoiseFile
+  # Chef resources and providers for poise-file.
+  #
+  # @since 1.0.0
+  module Resources
+  end
+end

data/lib/poise_file/resources/poise_file.rb

@@ -0,0 +1,242 @@
+#
+# Copyright 2017, 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/file_content_management/content_base'
+require 'chef/file_content_management/tempfile'
+require 'chef/resource/file'
+require 'chef/provider/file'
+require 'poise'
+
+
+module PoiseFile
+  module Resources
+    # (see PoiseFile::Resource)
+    # @since 1.0.0
+    module PoiseFile
+      # A `poise_file` resource to write out a file with some nice helpers.
+      #
+      # @provides poise_file
+      # @action create
+      # @action delete
+      # @action touch
+      # @action create_if_missing
+      # @example
+      #   poise_file '/etc/myapp.json' do
+      #     content listen: 80, debug: false
+      #   end
+      class Resource < Chef::Resource::File
+        include Poise
+        provides(:poise_file)
+        actions(:create, :delete, :touch, :create_if_missing)
+
+        # @!attribute content
+        #   Format to write the file in. `text` is the same as the core `file`
+        #   resource, `json` writes the content as a JSON object, `yaml` as a
+        #   YAML object.
+        #   @return [String, Symbol]
+        attribute(:content, kind_of: [String, Hash, Array])
+
+        # @!attribute format
+        #   Format to write the file in. `text` is the same as the core `file`
+        #   resource, `json` writes the content as a JSON object, `yaml` as a
+        #   YAML object.
+        #   @return [String, Symbol]
+        attribute(:format, kind_of: [String, Symbol], default: lazy { default_format })
+
+        # @!attribute pattern
+        #   Regular expression pattern to use for an in-place update of the file.
+        #   If given a Proc it should take two arguments, the current content of
+        #   the file and the resource object.
+        #   @see #pattern_location
+        #   @return [String, Regexp, Proc, nil, false]
+        attribute(:pattern, kind_of: [String, Regexp, Proc, NilClass, FalseClass], default: nil)
+
+        # @!attribute pattern_location
+        #   Location to insert the {#content} data at. Must be one of:
+        #   * replace: Overwrite the pattern.
+        #   * replace_or_add: Overwrite the patter or append to the file if the
+        #      pattern is not present.
+        #   * before: Insert the {#content} immediately before the pattern if it
+        #     doesn't already exist.
+        #   * after: Insert the {#content} immediately after the pattern if it
+        #     doesn't already exist.
+        #   @see #pattern
+        #   @return [String, Symbol]
+        attribute(:pattern_location, kind_of: [String, Symbol], default: 'replace_or_add')
+
+        private
+
+        # Find the default format based on the file path.
+        #
+        # @api private
+        # @return [String]
+        def default_format
+          # If we have a pattern, ignore the format system by default. If we
+          # have string content, it's just raw content by default.
+          return 'text' if pattern || content.is_a?(String)
+          case path
+          when /\.json$/
+            'json'
+          when /\.ya?ml$/
+            'yaml'
+          else
+            'text'
+          end
+        end
+      end
+
+      # File content class for `poise_file`.
+      #
+      # @api private
+      # @see Resource
+      class Content < Chef::FileContentManagement::ContentBase
+        # Required abstract method for ContentBase. Builds the new content of
+        # file in a tempfile or returns nil to not touch the file content.
+        #
+        # @return [Chef::FileContentManagement::Tempfile, nil]
+        def file_for_provider
+          if @new_resource.content
+            if @new_resource.pattern && @new_resource.format.to_s != 'text'
+              raise ArgumentError.new("Cannot use `pattern` property and `format` property together")
+            end
+
+            tempfile = Chef::FileContentManagement::Tempfile.new(@new_resource).tempfile
+            content = if @new_resource.pattern
+              content_for_pattern
+            else
+              content_for_format
+            end
+            tempfile.write(content)
+            tempfile.close
+            tempfile
+          else
+            nil
+          end
+        end
+
+        private
+
+        # Build the content when using the edit-in-place mode.
+        #
+        # @api private
+        # @return [String]
+        def content_for_pattern
+          # Get the base content to start from.
+          existing_content = if ::File.exist?(@new_resource.path)
+            IO.read(@new_resource.path)
+          else
+            # Pretend the file is empty if it doesn't already exist.
+            ''
+          end
+
+          # If we were given a proc, use it.
+          if @new_resource.pattern.is_a?(Proc)
+            return @new_resource.pattern.call(existing_content, @new_resource)
+          end
+
+          # Build the pattern.
+          pattern = if @new_resource.pattern.is_a?(Regexp)
+            # Should this dup the pattern because weird tracking stuff?
+            @new_resource.pattern
+          else
+            # Deal with newlines at the end of a line because $ matches before
+            # newline, not after.
+            pattern_string = if @new_resource.content.end_with?("\n")
+              @new_resource.pattern.gsub(/\$\Z/, "$\n?")
+            else
+              @new_resource.pattern
+            end
+            # Ruby will show a warning if trying to add options to an existing
+            # Regexp instance so only use that if it's a string.
+            Regexp.new(pattern_string, Regexp::MULTILINE)
+          end
+
+          # Run the pattern operation.
+          case @new_resource.pattern_location.to_s
+          when 'replace'
+            # Overwrite the matched section.
+            existing_content.gsub!(pattern, @new_resource.content) || existing_content
+          when 'replace_or_add'
+            # Overwrite the pattern if it matches otherwise append.
+            existing_content.gsub!(pattern, @new_resource.content) || (existing_content << @new_resource.content)
+          when 'before'
+            # Insert the content before the pattern if it doesn't already exist.
+            match = pattern.match(existing_content)
+            if match
+              if match.pre_match.end_with?(@new_resource.content)
+                existing_content
+              else
+                '' << match.pre_match << @new_resource.content << match[0] << match.post_match
+              end
+            else
+              existing_content
+            end
+          when 'after'
+            # Insert the content after the pattern if it doesn't already exist.
+            match = pattern.match(existing_content)
+            if match
+              if match.post_match.start_with?(@new_resource.content)
+                existing_content
+              else
+                '' << match.pre_match << match[0] << @new_resource.content << match.post_match
+              end
+            else
+              existing_content
+            end
+          else
+            raise ArgumentError.new("Unknown file pattern location #{@new_resource.pattern_location.inspect}")
+          end
+        end
+
+        # Build the content when using format mode (i.e. when not using the
+        # edit-in-place mode).
+        #
+        # @api private
+        # @return [String]
+        def content_for_format
+          case @new_resource.format.to_s
+          when 'json'
+            require 'chef/json_compat'
+            # Make sure we include the trailing newline because YAML has one.
+            Chef::JSONCompat.to_json_pretty(@new_resource.content) + "\n"
+          when 'yaml'
+            require 'yaml'
+            YAML.dump(@new_resource.content)
+          when 'text'
+            @new_resource.content
+          else
+            raise ArgumentError.new("Unknown file format #{@new_resource.format.inspect}")
+          end
+        end
+      end
+
+      # Provider for `poise_file`.
+      #
+      # @see Resource
+      # @provides poise_file
+      class Provider < Chef::Provider::File
+        include Poise
+        provides(:poise_file)
+
+        def initialize(new_resource, run_context)
+          @content_class = Content
+          super
+        end
+      end
+    end
+  end
+end

data/lib/poise_file/version.rb

@@ -0,0 +1,21 @@
+#
+# Copyright 2017, 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 PoiseFile
+  VERSION = '1.0.0'
+end

data/poise-file.gemspec

@@ -0,0 +1,42 @@
+#
+# Copyright 2017, 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.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poise_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise-file'
+  spec.version = PoiseFile::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = 'A Chef cookbook for advanced file managent.'
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/poise-file'
+  spec.license = 'Apache-2.0'
+  spec.metadata['platforms'] = 'any'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{lib}
+
+  spec.add_dependency 'chef', '>= 12.1', '< 14'
+  spec.add_dependency 'halite', '~> 1.0'
+  spec.add_dependency 'poise', '~> 2.0'
+
+  spec.add_development_dependency 'poise-boiler', '~> 1.0'
+end

data/test/cookbook/metadata.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2017, 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.
+#
+
+name 'poise-file_test'
+depends 'poise-file'

data/test/cookbook/recipes/default.rb

@@ -0,0 +1,36 @@
+#
+# Copyright 2017, 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.
+#
+
+poise_file '/poise_test' do
+  content "I'm a little teapot\n"
+end
+
+poise_file '/poise_test.json' do
+  content ['short and stout', {here: 'is my handle'}]
+end
+
+poise_file '/poise_test.yml' do
+  content 'here' => 'is my spout', 'when' => ['I', 'get', 'all', 'steamed', 'up']
+end
+
+file '/poise_test_pattern' do
+  content "I must shout\ntip me over\n"
+end
+
+poise_file '/poise_test_pattern' do
+  content 'yell'
+  pattern 'shout'
+end