serverkit 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c63fd1655ae7424f508d32cdaefa5c0e83090117
-  data.tar.gz: b4c5a55c88bb2e2031dd3321f26443c32bdf79a6
+  metadata.gz: 6bc4285bf5a80516d782219e3e1c39e2293bd149
+  data.tar.gz: e5aa09260d3f3312d59387e4b6d5be6931194a08
 SHA512:
-  metadata.gz: 66c44fa0c113ccbde06013a4eab9d63ec42175572e8c6dd3848e764531d404d665f8668a5367df74d8186a80522e7dac8a13e3072a36cb0d633947ac8e55f6c1
-  data.tar.gz: 28ae2520dc1e0805e070cff7cc4ebb7d5f4e5725d5ec27f7e4948314a38ead1442a16f7079ff0f4758296c7a5d14a129e5203815c3e963c53c0f5ef2c2ee8fc4
+  metadata.gz: 4a8adc794c2315262a5bf14713fef1d36d069fe0c7776b64402de888a66bc364b22ee601205f0c13ff5144dd5561cf900959055faba6a8b5d5fb4a7afe658ef9
+  data.tar.gz: ed16eac1e8ba241522920ec7fd5137063588e1e78fd3993e1ffa9c802f2e3111f7663a3a0d3fb3be14140cbc1bcca406dd337f7fcd0673dfd47342095b1f35c2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.4
+- Add template resource
+- Prevent abstract class from being used as resource type
+
 ## 0.4.3
 - Add directory resource
 - Add file resource

data/README.md

@@ -194,17 +194,18 @@ By default, all types of resource can or must have the following attributes:
 ### Type
 A resource must have a valid type attribute like:
 
-- command
-- directory
-- file
-- git
-- nothing
-- package
-- recipe
-- remote_file
-- service
-- symlink
-- user
+- [command](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/command.rb)
+- [directory](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/directory.rb)
+- [file](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/file.rb)
+- [git](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/git.rb)
+- [nothing](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/nothing.rb)
+- [package](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/package.rb)
+- [recipe](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/recipe.rb)
+- [remote_file](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/remote_file.rb)
+- [service](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/service.rb)
+- [symlink](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/symlink.rb)
+- [template](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/template.rb)
+- [user](https://github.com/r7kamura/serverkit/blob/master/lib/serverkit/resources/user.rb)
 
 ### Example
 An example package resource that has type and name attributes.

data/example/recipe.yml

@@ -13,3 +13,6 @@ resources:
   - type: directory
     path: /Users/test
     owner: test
+  - type: template
+    source: example/template.erb
+    destination: /tmp/template_test

data/example/template.erb

@@ -0,0 +1 @@
+<%= message %>

data/example/variables.yml

@@ -0,0 +1 @@
+message: test

data/lib/serverkit/loaders/base_loader.rb

@@ -86,8 +86,6 @@ module Serverkit
         case
         when has_executable_path?
           load_data_from_executable
-        when has_erb_path?
-          load_data_from_erb
         when has_yaml_path?
           load_data_from_yaml
         else

data/lib/serverkit/resource_builder.rb

@@ -10,6 +10,7 @@ require "serverkit/resources/recipe"
 require "serverkit/resources/remote_file"
 require "serverkit/resources/service"
 require "serverkit/resources/symlink"
+require "serverkit/resources/template"
 require "serverkit/resources/unknown"
 require "serverkit/resources/user"
 
@@ -29,8 +30,16 @@ module Serverkit
 
     private
 
+    # @return [Array<Class>]
+    def available_resource_classes
+      Resources.constants.select do |constant_name|
+        constant = Resources.const_get(constant_name)
+        constant < Resources::Base && !constant.abstract_class?
+      end
+    end
+
     def has_known_type?
-      Resources.constants.map(&:to_s).include?(resource_class_name)
+      available_resource_classes.map(&:to_s).include?(resource_class_name)
     end
 
     # @return [Class]

data/lib/serverkit/resources/base.rb

@@ -9,6 +9,12 @@ module Serverkit
   module Resources
     class Base
       class << self
+        attr_writer :abstract_class
+
+        def abstract_class?
+          !!@abstract_class
+        end
+
         # @note DSL method to define attribute with its validations
         def attribute(name, options = {})
           default = options.delete(:default)
@@ -41,6 +47,8 @@ module Serverkit
         to: :backend,
       )
 
+      self.abstract_class = true
+
       # @param [Serverkit::Recipe] recipe
       # @param [Hash] attributes
       def initialize(recipe, attributes)

data/lib/serverkit/resources/directory.rb

@@ -1,68 +1,25 @@
-require "serverkit/resources/base"
+require "serverkit/resources/entry"
 
 module Serverkit
   module Resources
-    class Directory < Base
-      attribute :group, type: String
-      attribute :mode, type: [Integer, String]
-      attribute :owner, type: String
+    class Directory < Entry
       attribute :path, required: true, type: String
 
-      # @note Override
-      def apply
-        create_directory unless has_correct_directory?
-        update_group unless has_correct_group?
-        update_mode unless has_correct_mode?
-        update_owner unless has_correct_owner?
-      end
-
-      # @note Override
-      def check
-        has_correct_directory? && has_correct_group? && has_correct_mode? && has_correct_owner?
-      end
-
       private
 
-      def create_directory
-        run_command_from_identifier(:create_file_as_directory, path)
-      end
-
-      def has_correct_directory?
-        check_command_from_identifier(:check_file_is_directory, path)
-      end
-
-      def has_correct_group?
-        group.nil? || check_command_from_identifier(:check_file_is_grouped, path, group)
-      end
-
-      def has_correct_mode?
-        mode.nil? || check_command_from_identifier(:check_file_has_mode, path, mode_in_octal_notation)
-      end
-
-      def has_correct_owner?
-        owner.nil? || check_command_from_identifier(:check_file_is_owned_by, path, owner)
-      end
-
-      # @return [String]
-      # @example "755" # for 0755
-      def mode_in_octal_notation
-        if mode.is_a?(Integer)
-          mode.to_s(8)
-        else
-          mode
-        end
-      end
-
-      def update_group
-        run_command_from_identifier(:change_file_group, path, group)
+      # @note Override
+      def destination
+        path
       end
 
-      def update_mode
-        run_command_from_identifier(:change_file_mode, path, mode_in_octal_notation)
+      # @note Override
+      def has_correct_entry?
+        check_command_from_identifier(:check_file_is_directory, destination)
       end
 
-      def update_owner
-        run_command_from_identifier(:change_file_owner, path, owner)
+      # @note Override
+      def update_entry
+        run_command_from_identifier(:create_file_as_directory, destination)
       end
     end
   end

data/lib/serverkit/resources/entry.rb

@@ -0,0 +1,107 @@
+require "digest"
+require "serverkit/resources/base"
+require "tempfile"
+
+module Serverkit
+  module Resources
+    # Abstract class for file and directory
+    class Entry < Base
+      attribute :group, type: String
+      attribute :mode, type: [Integer, String]
+      attribute :owner, type: String
+
+      self.abstract_class = true
+
+      # @note Override
+      def apply
+        update_entry unless has_correct_entry?
+        update_group unless has_correct_group?
+        update_mode unless has_correct_mode?
+        update_owner unless has_correct_owner?
+      end
+
+      # @note Override
+      def check
+        has_correct_entry? && has_correct_group? && has_correct_mode? && has_correct_owner?
+      end
+
+      private
+
+      # @note Override me
+      # @return [String] Path to the entry on remote side
+      def destination
+        raise NotImplementedError
+      end
+
+      def has_correct_content?
+        content.nil? || remote_file_sha256sum == local_content_sha256sum
+      end
+
+      # @note Override me
+      def has_correct_entry?
+        raise NotImplementedError
+      end
+
+      def has_correct_group?
+        group.nil? || check_command_from_identifier(:check_file_is_grouped, destination, group)
+      end
+
+      def has_correct_mode?
+        mode.nil? || check_command_from_identifier(:check_file_has_mode, destination, mode_in_octal_notation)
+      end
+
+      def has_correct_owner?
+        owner.nil? || check_command_from_identifier(:check_file_is_owned_by, destination, owner)
+      end
+
+      def has_remote_file?
+        check_command_from_identifier(:check_file_is_file, destination)
+      end
+
+      # @return [String]
+      def local_content_sha256sum
+        ::Digest::SHA256.hexdigest(content)
+      end
+
+      # @return [String]
+      # @example "755" # for 0755
+      def mode_in_octal_notation
+        if mode.is_a?(Integer)
+          mode.to_s(8)
+        else
+          mode
+        end
+      end
+
+      # @return [String]
+      def remote_file_sha256sum
+        run_command_from_identifier(:get_file_sha256sum, destination).stdout.rstrip
+      end
+
+      def send_content_to_destination
+        ::Tempfile.open("") do |file|
+          file.write(content || "")
+          file.close
+          backend.send_file(file.path, destination)
+        end
+      end
+
+      # @note Override me
+      def update_entry
+        raise NotImplementedError
+      end
+
+      def update_group
+        run_command_from_identifier(:change_file_group, destination, group)
+      end
+
+      def update_mode
+        run_command_from_identifier(:change_file_mode, destination, mode_in_octal_notation)
+      end
+
+      def update_owner
+        run_command_from_identifier(:change_file_owner, destination, owner)
+      end
+    end
+  end
+end

data/lib/serverkit/resources/file.rb

@@ -1,93 +1,27 @@
-require "digest"
-require "serverkit/resources/base"
+require "serverkit/resources/entry"
 require "tempfile"
 
 module Serverkit
   module Resources
-    class File < Base
+    class File < Entry
       attribute :content, type: String
-      attribute :group, type: String
-      attribute :mode, type: [Integer, String]
-      attribute :owner, type: String
       attribute :path, required: true, type: String
 
-      # @note Override
-      def apply
-        update_file unless has_correct_file?
-        update_group unless has_correct_group?
-        update_mode unless has_correct_mode?
-        update_owner unless has_correct_owner?
-      end
-
-      # @note Override
-      def check
-        has_correct_file? && has_correct_group? && has_correct_mode? && has_correct_owner?
-      end
-
       private
 
-      # @return [String]
-      def content_sha256sum
-        ::Digest::SHA256.hexdigest(content)
-      end
-
-      # @return [String]
-      def file_sha256sum
-        run_command_from_identifier(:get_file_sha256sum, path).stdout.rstrip
-      end
-
-      def has_file?
-        check_command_from_identifier(:check_file_is_file, path)
-      end
-
-      def has_correct_content?
-        content.nil? || file_sha256sum == content_sha256sum
-      end
-
-      def has_correct_file?
-        has_file? && has_correct_content?
-      end
-
-      def has_correct_group?
-        group.nil? || check_command_from_identifier(:check_file_is_grouped, path, group)
-      end
-
-      def has_correct_mode?
-        mode.nil? || check_command_from_identifier(:check_file_has_mode, path, mode_in_octal_notation)
-      end
-
-      def has_correct_owner?
-        owner.nil? || check_command_from_identifier(:check_file_is_owned_by, path, owner)
-      end
-
-      # @return [String]
-      # @example "755" # for 0755
-      def mode_in_octal_notation
-        if mode.is_a?(Integer)
-          mode.to_s(8)
-        else
-          mode
-        end
-      end
-
-      def update_file
-        ::Tempfile.open("") do |file|
-          file.write(content || "")
-          file.close
-          backend.send_file(file.path, path)
-        end
-      end
-
-      def update_group
-        run_command_from_identifier(:change_file_group, path, group)
+      # @note Override
+      def destination
+        path
       end
 
-      def update_mode
-        run_command_from_identifier(:change_file_mode, path, mode_in_octal_notation)
+      # @note Override
+      def has_correct_entry?
+        has_remote_file? && has_correct_content?
       end
 
-      def update_owner
-        run_command_from_identifier(:change_file_owner, path, owner)
+      # @note Override
+      def update_entry
+        send_content_to_destination
       end
     end
   end

data/lib/serverkit/resources/remote_file.rb

@@ -1,67 +1,24 @@
-require "digest"
-require "serverkit/resources/base"
+require "serverkit/resources/entry"
 
 module Serverkit
   module Resources
-    class RemoteFile < Base
+    class RemoteFile < Entry
       attribute :destination, required: true, type: String
-      attribute :group, type: String
-      attribute :owner, type: String
       attribute :source, readable: true, required: true, type: String
 
-      # @note Override
-      def apply
-        send_file_from_source_to_destination if file_sendable?
-        change_group unless has_valid_group?
-        change_owner unless has_valid_owner?
-      end
-
-      # @note Override
-      def check
-        has_file? && has_same_content? && has_valid_group? && has_valid_owner?
-      end
-
       private
 
-      def change_group
-        run_command_from_identifier(:change_file_group, destination, group)
-      end
-
-      def change_owner
-        run_command_from_identifier(:change_file_owner, destination, owner)
-      end
-
-      def file_sendable?
-        !has_file? || !has_same_content?
-      end
-
-      def has_file?
-        check_command_from_identifier(:check_file_is_file, destination)
-      end
-
-      def has_same_content?
-        remote_file_sha256sum == local_file_sha256sum
+      def content
+        @content ||= ::File.read(source)
       end
 
-      def has_valid_group?
-        group.nil? || check_command_from_identifier(:check_file_is_grouped, destination, group)
-      end
-
-      def has_valid_owner?
-        owner.nil? || check_command_from_identifier(:check_file_is_owned_by, destination, owner)
-      end
-
-      # @return [String]
-      def local_file_sha256sum
-        ::Digest::SHA256.hexdigest(::File.read(source))
-      end
-
-      # @return [String]
-      def remote_file_sha256sum
-        run_command_from_identifier(:get_file_sha256sum, destination).stdout.rstrip
+      # @note Override
+      def has_correct_entry?
+        has_remote_file? && has_correct_content?
       end
 
-      def send_file_from_source_to_destination
+      # @note Override
+      def update_entry
         send_file(source, destination)
       end
     end

data/lib/serverkit/resources/template.rb

@@ -0,0 +1,40 @@
+require "erb"
+require "serverkit/loaders/variables_loader"
+require "serverkit/resources/entry"
+require "tempfile"
+
+module Serverkit
+  module Resources
+    class Template < RemoteFile
+      DEFAULT_VARIABLES_DATA = {}
+
+      private
+
+      # @note Override
+      def content
+        @content ||= ::ERB.new(template_content, nil, "-").result(variables.to_mash.binding)
+      end
+
+      # @return [String] ERB content
+      def template_content
+        @template ||= ::File.read(source)
+      end
+
+      # @note Override
+      def update_entry
+        send_content_to_destination
+      end
+
+      # @return [Serverkit::Variables]
+      def variables
+        @variables ||= begin
+          if recipe.variables_path
+            Loaders::VariablesLoader.new(recipe.variables_path).load
+          else
+            Variables.new(DEFAULT_VARIABLES_DATA.dup)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-19 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -212,6 +212,8 @@ files:
 - Vagrantfile
 - bin/serverkit
 - example/recipe.yml
+- example/template.erb
+- example/variables.yml
 - lib/readable_validator.rb
 - lib/required_validator.rb
 - lib/serverkit.rb
@@ -243,6 +245,7 @@ files:
 - lib/serverkit/resources/base.rb
 - lib/serverkit/resources/command.rb
 - lib/serverkit/resources/directory.rb
+- lib/serverkit/resources/entry.rb
 - lib/serverkit/resources/file.rb
 - lib/serverkit/resources/git.rb
 - lib/serverkit/resources/missing.rb
@@ -252,6 +255,7 @@ files:
 - lib/serverkit/resources/remote_file.rb
 - lib/serverkit/resources/service.rb
 - lib/serverkit/resources/symlink.rb
+- lib/serverkit/resources/template.rb
 - lib/serverkit/resources/unknown.rb
 - lib/serverkit/resources/user.rb
 - lib/serverkit/variables.rb