serverkit 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10080848f2805e6c3836073587e6be22407c01e6
-  data.tar.gz: 0867ac71a5aa865f8448aa12afbb513ed7c99db8
+  metadata.gz: 40d5fe026687af52454bb4f3507ee76df5c24892
+  data.tar.gz: f5ff7864e5a727ee33b68bc66624b9bc338d1a6d
 SHA512:
-  metadata.gz: d69a3bf329a1cad28e178f10a3767aac3c2b2b03dbb6b431d71827e8883e9628e0543ca4e7633dc9e80a32a9c206cfad4f8d5466e480f68036a70bb04b5ac649
-  data.tar.gz: 353146a60c1c4fe93439b205bba7750073459ffdcdd891ecfaa2f165bfddacab863692d2eb041d667c5caa22c18ee7b925ea9cb2f78f82db5a5ef3af1571d93a
+  metadata.gz: 2fe05e953601daa2a7dbaa05151d4142e09f8ef588af30e9e600efe3dd179f45843dff9aae5f6c7dd69e0a09b0eb65c950b748f67d2c27ca5971c3453ca1b8cd
+  data.tar.gz: 198e7ee4550b9aa16ff52a57056073612be2dcd00cd85cad0e0545b62881591343356312e84b2abe0def220b7311b893dd8cf3279ac3e619a5e731a5263d4df2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.5
+- Add `recipe` resource type
+- Improve validation error message
+
 ## 0.0.4
 - Support ERB recipe and variables injection
 

data/README.md

@@ -35,6 +35,7 @@ serverkit apply --recipe=recipe.json.erb --variables=variables.json
 serverkit apply --recipe=recipe.json.erb --variables=variables.json.erb
 serverkit apply --recipe=recipe.json.erb --variables=variables.yml
 serverkit apply --recipe=recipe.json.erb --variables=variables.yml.erb
+serverkit apply --recipe=recipe.json.erb --variables=variables/
 serverkit apply --recipe=recipe.yml
 serverkit apply --recipe=recipe.yml.erb
 serverkit apply --recipe=recipes/
@@ -82,9 +83,10 @@ A resource must have a type property. Currently the following types are availabl
 
 - file
 - git
-- homebrew_cask
 - homebrew
+- homebrew_cask
 - package
+- recipe
 - service
 - symlink
 

data/example/recipes/{recipe.yml.erb → dotfiles.yml.erb}

@@ -1,16 +1,4 @@
 resources:
-  - id: install_mysql
-    type: homebrew
-    name: mysql
-  - id: install_redis
-    type: homebrew
-    name: redis
-  - id: install_licecap
-    type: homebrew_cask
-    name: licecap
-  - id: install_alfred
-    type: homebrew_cask
-    name: alfred
   - id: clone_dotfiles
     type: git
     repository: git@github.com:<%= variables["dotfiles_github_repository"] %>.git

data/example/recipes/homebrew.yml

@@ -0,0 +1,7 @@
+resources:
+  - id: install_mysql
+    type: homebrew
+    name: mysql
+  - id: install_redis
+    type: homebrew
+    name: redis

data/example/recipes/homebrew_cask.yml

@@ -0,0 +1,7 @@
+resources:
+  - id: install_licecap
+    type: homebrew_cask
+    name: licecap
+  - id: install_alfred
+    type: homebrew_cask
+    name: alfred

data/example/recipes/recipe.json

@@ -1,36 +1,19 @@
 {
   "resources": [
     {
-      "id": "install_mysql",
-      "type": "homebrew",
-      "name": "mysql"
+      "id": "install_homebrew_packages",
+      "type": "recipe",
+      "path": "example/recipes/homebrew.yml"
     },
     {
-      "id": "install_redis",
-      "type": "homebrew",
-      "name": "redis"
+      "id": "install_homebrew_cask_packages",
+      "type": "recipe",
+      "path": "example/recipes/homebrew_cask.yml"
     },
     {
-      "id": "install_licecap",
-      "type": "homebrew_cask",
-      "name": "licecap"
-    },
-    {
-      "id": "install_alfred",
-      "type": "homebrew_cask",
-      "name": "alfred"
-    },
-    {
-      "id": "clone_dotfiles",
-      "type": "git",
-      "repository": "git@github.com:r7kamura/dotfiles.git",
-      "path": "/Users/r7kamura/src/github.com/r7kamura/dotfiles"
-    },
-    {
-      "id": "symlink_zshrc",
-      "type": "symlink",
-      "source": "/Users/r7kamura/.zshrc",
-      "destination": "/Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc"
+      "id": "install_dotfiles",
+      "type": "recipe",
+      "path": "example/recipes/dotfiles.yml.erb"
     }
   ]
-}
+}

data/example/recipes/recipe.yml

@@ -1,21 +1,10 @@
 resources:
-  - id: install_mysql
-    type: homebrew
-    name: mysql
-  - id: install_redis
-    type: homebrew
-    name: redis
-  - id: install_licecap
-    type: homebrew_cask
-    name: licecap
-  - id: install_alfred
-    type: homebrew_cask
-    name: alfred
-  - id: clone_dotfiles
-    type: git
-    repository: git@github.com:r7kamura/dotfiles.git
-    path: /Users/r7kamura/src/github.com/r7kamura/dotfiles
-  - id: symlink_zshrc
-    type: symlink
-    source: /Users/r7kamura/.zshrc
-    destination: /Users/r7kamura/src/github.com/r7kamura/dotfiles/linked/.zshrc
+  - id: install_homebrew_packages
+    type: recipe
+    path: example/recipes/homebrew.yml
+  - id: install_homebrew_cask_packages
+    type: recipe
+    path: example/recipes/homebrew_cask.yml
+  - id: install_dotfiles
+    type: recipe
+    path: example/recipes/dotfiles.yml.erb

data/lib/serverkit/errors/attribute_validation_error.rb

@@ -0,0 +1,20 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class AttributeValidationError < Base
+      # @param [Serverkit::Resources::Base] resource
+      # @param [String] validation_error_message
+      def initialize(resource, attribute_name, validation_error_message)
+        @attribute_name = attribute_name
+        @resource = resource
+        @validation_error_message = validation_error_message
+      end
+
+      # @return [String]
+      def to_s
+        "#{@attribute_name} attribute #{@validation_error_message} in #{@resource.type} resource"
+      end
+    end
+  end
+end

data/lib/serverkit/errors/{invalid_recipe_type.rb → invalid_recipe_type_error.rb}

@@ -2,7 +2,7 @@ require "serverkit/errors/base"
 
 module Serverkit
   module Errors
-    class InvalidRecipeType < Base
+    class InvalidRecipeTypeError < Base
       # @param [Class] type
       def initialize(type)
         @type = type

data/lib/serverkit/errors/{invalid_resources_type.rb → invalid_resources_type_error.rb}

@@ -2,7 +2,7 @@ require "serverkit/errors/base"
 
 module Serverkit
   module Errors
-    class InvalidResourcesType < Base
+    class InvalidResourcesTypeError < Base
       # @param [Class] type
       def initialize(type)
         @type = type

data/lib/serverkit/errors/unknown_resource_type_error.rb

@@ -0,0 +1,17 @@
+require "serverkit/errors/base"
+
+module Serverkit
+  module Errors
+    class UnknownResourceTypeError < Base
+      # @param [String] type
+      def initialize(type)
+        @type = type
+      end
+
+      # @return [String]
+      def to_s
+        "Unknown `#{@type}` resource type"
+      end
+    end
+  end
+end

data/lib/serverkit/loaders/base_loader.rb

@@ -15,7 +15,6 @@ module Serverkit
       end
 
       # @todo Rescue Error::ENOENT error
-      # @return [Serverkit::Recipe]
       def load
         case
         when has_directory_path?
@@ -23,7 +22,7 @@ module Serverkit
         when has_erb_path?
           load_from_erb
         else
-          loaded_class.new(load_data)
+          load_from_data
         end
       end
 
@@ -34,6 +33,16 @@ module Serverkit
         TOPLEVEL_BINDING
       end
 
+      # @note For override
+      def create_empty_loadable
+        loaded_class.new({})
+      end
+
+      # @return [String]
+      def execute
+        `#{pathname}`
+      end
+
       # @return [String]
       def expand_erb
         ERB.new(pathname.read).result(binding_for_erb)
@@ -54,11 +63,6 @@ module Serverkit
         end
       end
 
-      # @return [String]
-      def execute
-        `#{pathname}`
-      end
-
       def has_directory_path?
         pathname.directory?
       end
@@ -89,17 +93,19 @@ module Serverkit
         end
       end
 
-      # @return [Serverkit::Recipe]
+      def load_from_data
+        loaded_class.new(load_data)
+      end
+
       def load_from_directory
-        loads_from_directory.inject(loaded_class.new, :merge)
+        loads_from_directory.inject(create_empty_loadable, :merge)
       end
 
-      # @return [Serverkit::Recipe]
       def load_from_erb
         self.class.new(expanded_erb_tempfile.path).load
       end
 
-      # @return [Array<Serverkit::Recipe>]
+      # @return [Array]
       def loads_from_directory
         Dir.glob(pathname.join("*")).sort.flat_map do |path|
           self.class.new(path).load

data/lib/serverkit/loaders/recipe_loader.rb

@@ -21,10 +21,20 @@ module Serverkit
         ErbBindingContext.new(variables_data).binding
       end
 
+      # @note Override to pass @variables_path
+      def create_empty_loadable
+        loaded_class.new({}, @variables_path)
+      end
+
       def has_variables_path?
         !@variables_path.nil?
       end
 
+      # @note Override to pass @variables_path
+      def load_from_data
+        loaded_class.new(load_data, @variables_path)
+      end
+
       # @return [Serverkit::Variables]
       def load_variables
         Loaders::VariablesLoader.new(@variables_path).load

data/lib/serverkit/recipe.rb

@@ -1,21 +1,17 @@
 require "active_support/core_ext/hash/deep_merge"
-require "active_support/core_ext/string/inflections"
-require "serverkit/errors/invalid_recipe_type"
-require "serverkit/errors/invalid_resources_type"
-require "serverkit/resources/file"
-require "serverkit/resources/git"
-require "serverkit/resources/homebrew"
-require "serverkit/resources/homebrew_cask"
-require "serverkit/resources/service"
-require "serverkit/resources/symlink"
+require "serverkit/errors/invalid_recipe_type_error"
+require "serverkit/errors/invalid_resources_type_error"
+require "serverkit/resource_builder"
 
 module Serverkit
   class Recipe
-    attr_reader :recipe_data
+    attr_reader :recipe_data, :variables_path
 
     # @param [Hash] recipe_data
-    def initialize(recipe_data = {})
+    # @param [String, nil] variables_path Used for recipe resource to render ERB template
+    def initialize(recipe_data, variables_path = nil)
       @recipe_data = recipe_data
+      @variables_path = variables_path
     end
 
     # @return [Array<Serverkit::Errors::Base>]
@@ -32,11 +28,6 @@ module Serverkit
       end
     end
 
-    # @return [Array<String>]
-    def hosts
-      @recipe_data["hosts"]
-    end
-
     # @param [Serverkit::Recipe] recipe
     # @return [Serverkit::Recipe]
     def merge(recipe)
@@ -51,11 +42,11 @@ module Serverkit
       )
     end
 
+    # @note recipe resource will be expanded into resources defined in its recipe
     # @return [Array<Serverkit::Resources::Base>]
-    # @todo Delegate to resource builder
     def resources
-      @resources ||= resources_property.map do |attributes|
-        Resources.const_get(attributes["type"].camelize, false).new(attributes)
+      @resources ||= resources_property.flat_map do |attributes|
+        ResourceBuilder.new(self, attributes).build.to_a
       end
     end
 
@@ -67,20 +58,17 @@ module Serverkit
 
     # @return [Array<Serverkit::Errors::Base>]
     def errors_for_invalid_typed_recipe_data
-      [Errors::InvalidRecipeType.new(@recipe_data.class)]
+      [Errors::InvalidRecipeTypeError.new(@recipe_data.class)]
     end
 
     # @return [Array<Serverkit::Errors::Base>]
     def errors_for_invalid_typed_resources_property
-      [Errors::InvalidResourcesType.new(resources_property.class)]
+      [Errors::InvalidResourcesTypeError.new(resources_property.class)]
     end
 
-    # @return [Array<Serverkit::Errors::Base>]
+    # @return [Array<Serverkit::Errors::AttributeValidationError>]
     def errors_in_resources
-      resources.flat_map do |resource|
-        resource.validate
-        resource.errors.to_a
-      end
+      resources.flat_map(&:all_errors)
     end
 
     def has_valid_typed_resources_property?

data/lib/serverkit/resource_builder.rb

@@ -0,0 +1,51 @@
+require "active_support/core_ext/string/inflections"
+require "serverkit/resources/file"
+require "serverkit/resources/git"
+require "serverkit/resources/homebrew_cask"
+require "serverkit/resources/homebrew"
+require "serverkit/resources/recipe"
+require "serverkit/resources/service"
+require "serverkit/resources/symlink"
+require "serverkit/resources/unknown"
+
+module Serverkit
+  class ResourceBuilder
+    # @param [Serverkit::Recipe] recipe
+    # @param [Hash] attributes
+    def initialize(recipe, attributes)
+      @attributes = attributes
+      @recipe = recipe
+    end
+
+    # @return [Serverkit::Resources::Base]
+    def build
+      resource_class.new(@recipe, @attributes)
+    end
+
+    private
+
+    def has_known_type?
+      Resources.constants.map(&:to_s).include?(resource_class_name)
+    end
+
+    # @return [Class]
+    def resource_class
+      if has_known_type?
+        Resources.const_get(resource_class_name, false)
+      else
+        Resources::Unknown
+      end
+    end
+
+    # @return [String] (e.g. "File", "Symlink")
+    def resource_class_name
+      type.camelize
+    end
+
+    # @note Expected to return String in normal case
+    # @return [Object] (e.g. "file", "symlink")
+    def type
+      @attributes["type"]
+    end
+  end
+end

data/lib/serverkit/resources/base.rb

@@ -1,6 +1,7 @@
 require "active_model"
 require "readable_validator"
 require "required_validator"
+require "serverkit/errors/attribute_validation_error"
 require "type_validator"
 
 module Serverkit
@@ -21,15 +22,44 @@ module Serverkit
 
       attr_accessor :backend
 
+      attr_reader :recipe
+
       attribute :id, required: true, type: String
 
+      # @param [Serverkit::Recipe] recipe
       # @param [Hash] attributes
-      def initialize(attributes)
+      def initialize(recipe, attributes)
         @attributes = attributes
+        @recipe = recipe
+      end
+
+      # @note For override use
+      # @return [Array<Serverkit::Errors::Base>]
+      def all_errors
+        attribute_validation_errors
+      end
+
+      # @note recipe resource will override to replace itself with multiple resources
+      # @return [Array<Serverkit::Resources::Base>]
+      def to_a
+        [self]
+      end
+
+      # @return [String]
+      def type
+        @attributes["type"]
       end
 
       private
 
+      # @return [Array<Serverkit::Errors::AttributeValidationError>]
+      def attribute_validation_errors
+        validate
+        errors.map do |attribute_name, message|
+          Serverkit::Errors::AttributeValidationError.new(self, attribute_name, message)
+        end
+      end
+
       # @return [true, false]
       def check_command(*args)
         run_command(*args).success?

data/lib/serverkit/resources/recipe.rb

@@ -0,0 +1,21 @@
+require "serverkit/resources/base"
+
+module Serverkit
+  module Resources
+    class Recipe < Base
+      attribute :path, readable: true, required: true, type: String
+
+      # @note Override
+      def to_a
+        loaded_recipe.resources
+      end
+
+      private
+
+      # @return [Serverkit::Recipe] Recipe loaded from given path
+      def loaded_recipe
+        @loaded_recipe ||= Loaders::RecipeLoader.new(path, variables_path: recipe.variables_path).load
+      end
+    end
+  end
+end

data/lib/serverkit/resources/unknown.rb

@@ -0,0 +1,13 @@
+require "serverkit/errors/unknown_resource_type_error"
+require "serverkit/resources/base"
+
+module Serverkit
+  module Resources
+    class Unknown < Base
+      # @return [Array<Serverkit::Errors::UnknownResourceTypeError>]
+      def all_errors
+        [Errors::UnknownResourceTypeError.new(type)]
+      end
+    end
+  end
+end

data/lib/serverkit/variables.rb

@@ -5,7 +5,7 @@ module Serverkit
     attr_reader :variables_data
 
     # @param [Hash] variables_data
-    def initialize(variables_data = {})
+    def initialize(variables_data)
       @variables_data = variables_data
     end
 

data/lib/serverkit/version.rb

@@ -1,3 +1,3 @@
 module Serverkit
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverkit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -154,10 +154,12 @@ files:
 - README.md
 - Rakefile
 - bin/serverkit
+- example/recipes/dotfiles.yml.erb
+- example/recipes/homebrew.yml
+- example/recipes/homebrew_cask.yml
 - example/recipes/recipe.json
 - example/recipes/recipe.rb
 - example/recipes/recipe.yml
-- example/recipes/recipe.yml.erb
 - example/variables/variables.yml
 - lib/readable_validator.rb
 - lib/required_validator.rb
@@ -167,21 +169,26 @@ files:
 - lib/serverkit/actions/check.rb
 - lib/serverkit/actions/validate.rb
 - lib/serverkit/command.rb
+- lib/serverkit/errors/attribute_validation_error.rb
 - lib/serverkit/errors/base.rb
-- lib/serverkit/errors/invalid_recipe_type.rb
-- lib/serverkit/errors/invalid_resources_type.rb
+- lib/serverkit/errors/invalid_recipe_type_error.rb
+- lib/serverkit/errors/invalid_resources_type_error.rb
+- lib/serverkit/errors/unknown_resource_type_error.rb
 - lib/serverkit/loaders/base_loader.rb
 - lib/serverkit/loaders/recipe_loader.rb
 - lib/serverkit/loaders/variables_loader.rb
 - lib/serverkit/recipe.rb
+- lib/serverkit/resource_builder.rb
 - lib/serverkit/resources/base.rb
 - lib/serverkit/resources/file.rb
 - lib/serverkit/resources/git.rb
 - lib/serverkit/resources/homebrew.rb
 - lib/serverkit/resources/homebrew_cask.rb
 - lib/serverkit/resources/package.rb
+- lib/serverkit/resources/recipe.rb
 - lib/serverkit/resources/service.rb
 - lib/serverkit/resources/symlink.rb
+- lib/serverkit/resources/unknown.rb
 - lib/serverkit/variables.rb
 - lib/serverkit/version.rb
 - lib/type_validator.rb