itamae 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8b0f4978f8d00ca41234de5b288befcdc1f0f68
-  data.tar.gz: 20ad47b014f03d7af8ac547152281c5c0fbd9f99
+  metadata.gz: 240aa7e6557872fd35c36c24692c8a0e3f714809
+  data.tar.gz: 516ef413cfc3a830f63fb83b9d1207fff66a5f00
 SHA512:
-  metadata.gz: dd694c3e13fa40bbee8862338c59ff8079dd30763ba2710c9868e9a4dda8bda080baef7a46a8a21c4b67fdecab051447eb2064015625e1e5f843f741de767c85
-  data.tar.gz: 3d95d7a8a67337c18b56d569e3b6e45dfe65331e9a522a5d7f5a8586c330698c81199699584f94080b52befdaf561ffd5d4c9b683958244f1175515e8abf735f
+  metadata.gz: 769d71f69c3452ebfbfae501b1278a1931ca5306ce00f2c88a681586e1da78ecc83f723b0f04616c4216c2901158dde1f5e98fb62c8f52e5c299699eb99abc8b
+  data.tar.gz: 16cde3481cf61c3d8aa60adaa3e630e293f36263674dea4dda08cde2e83cc54bf048746501fc0de098dbc6b7ec84ee45dda63da65653195dbd6414392b9dc46c

data/README.md

@@ -1,13 +1,13 @@
-# Itamae
+# Itamae [![Gem Version](https://badge.fury.io/rb/itamae.svg)](http://badge.fury.io/rb/itamae)
 
-Configuration management tool like Chef which is simpler and lighter than Chef
+Simple and lightweight configuration management tool inspired by Chef.
 
 ## Concept
 
-* Good DSL like Chef
-* Simpler and lighter than Chef
-* It's just like Chef. No compatibility.
-* Idempotent.
+- Chef-like DSL
+- Simpler and lighter weight than Chef
+- Not compatible with Chef
+- Idempotent
 
 ## Installation
 
@@ -22,7 +22,7 @@ $ gem install itamae
 ```
 $ sudo itamae execute -j example/node.json example/recipe.rb
 D, [2013-12-24T14:05:50.859587 #7156] DEBUG -- : Loading node data from /vagrant/example/node.json ...
-I, [2013-12-24T14:05:50.862072 #7156]  INFO -- : >>> Executing Itamae::Resources::Package ({:action=>:install, :name=>"git"})...
+I, [2013-12-24T14:05:50.862072 #7156]  INFO -- : >>> Executing Itamae::Resource::Package ({:action=>:install, :name=>"git"})...
 D, [2013-12-24T14:05:51.335070 #7156] DEBUG -- : Command `apt-get -y install git` succeeded
 D, [2013-12-24T14:05:51.335251 #7156] DEBUG -- : STDOUT> Reading package lists...
 Building dependency tree...
@@ -31,7 +31,7 @@ git is already the newest version.
 0 upgraded, 0 newly installed, 0 to remove and 156 not upgraded.
 D, [2013-12-24T14:05:51.335464 #7156] DEBUG -- : STDERR>
 I, [2013-12-24T14:05:51.335531 #7156]  INFO -- : <<< Succeeded.
-I, [2013-12-24T14:05:51.335728 #7156]  INFO -- : >>> Executing Itamae::Resources::File ({:action=>:create, :source=>"foo", :path=>"/home/vagrant/foo"})...
+I, [2013-12-24T14:05:51.335728 #7156]  INFO -- : >>> Executing Itamae::Resource::File ({:action=>:create, :source=>"foo", :path=>"/home/vagrant/foo"})...
 D, [2013-12-24T14:05:51.335842 #7156] DEBUG -- : Copying a file from '/vagrant/example/foo' to '/home/vagrant/foo'...
 I, [2013-12-24T14:05:51.339119 #7156]  INFO -- : <<< Succeeded.
 ```

data/Rakefile

@@ -40,6 +40,7 @@ namespace :spec do
             cmd << " -u #{options[:user]}"
             cmd << " -p #{options[:port]}"
             cmd << " -i #{options[:keys].first}"
+            cmd << " -l #{ENV['LOG_LEVEL'] || 'debug'}"
             cmd << " -j spec/integration/recipes/node.json"
             cmd << " spec/integration/recipes/default.rb"
 

data/itamae.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "thor"
-  spec.add_runtime_dependency "specinfra", "2.0.0.beta20"
+  spec.add_runtime_dependency "specinfra", "2.0.0.beta32"
   spec.add_runtime_dependency "hashie"
+  spec.add_runtime_dependency "ansi"
 
   # TODO: move to specinfra
   spec.add_runtime_dependency "net-scp"

data/lib/itamae.rb

@@ -2,7 +2,8 @@ require "itamae/version"
 require "itamae/runner"
 require "itamae/cli"
 require "itamae/recipe"
-require "itamae/resources"
+require "itamae/resource"
+require "itamae/resource_collection"
 require "itamae/logger"
 require "itamae/node"
 require "itamae/specinfra"

data/lib/itamae/cli.rb

@@ -3,6 +3,14 @@ require 'thor'
 
 module Itamae
   class CLI < Thor
+    class_option :log_level, type: :string, aliases: ['-l'], default: 'info'
+
+    def initialize(*args)
+      super
+
+      Itamae::Logger.level = ::Logger.const_get(options[:log_level].upcase)
+    end
+
     desc "local RECIPE [RECIPE...]", "Run Itamae locally"
     option :node_json, type: :string, aliases: ['-j']
     def local(*recipe_files)

data/lib/itamae/logger.rb

@@ -1,16 +1,17 @@
 require 'itamae'
 require 'logger'
+require 'ansi/code'
 
 module Itamae
   module Logger
     class Formatter
       def call(severity, datetime, progname, msg)
-        "[%s] %5s : %s\n" % [format_datetime(datetime), severity, msg2str(msg)]
+        "[%s] %s : %s\n" % [format_datetime(datetime), color("%5s" % severity, severity), msg2str(msg)]
       end
 
       private
       def format_datetime(time)
-        time.strftime("%Y-%m-%dT%H:%M:%S.") << "%06d" % time.usec
+        time.strftime("%Y-%m-%dT%H:%M:%S%:z")
       end
 
       def msg2str(msg)
@@ -24,6 +25,18 @@ module Itamae
           msg.inspect
         end
       end
+
+      def color(str, severity)
+        color_code = case severity
+                     when "INFO"
+                       :green
+                     when "ERROR"
+                       :red
+                     else
+                       :clear
+                     end
+        ANSI.public_send(color_code) { str }
+      end
     end
 
     def self.logger

data/lib/itamae/recipe.rb

@@ -4,11 +4,15 @@ module Itamae
   class Recipe
     attr_reader :path
     attr_reader :runner
+    attr_reader :resources
+    attr_reader :delayed_actions
 
     def initialize(runner, path)
       @runner = runner
       @path = path
-      @resources = []
+      @resources = ResourceCollection.new
+      @delayed_actions = []
+
       load_resources
     end
 
@@ -18,15 +22,11 @@ module Itamae
 
     def run
       @resources.each do |resource|
-        Logger.info ">>> Executing #{resource.class.name} (#{resource.options})..."
-        begin
-          resource.run
-        rescue Resources::CommandExecutionError
-          Logger.error "<<< Failed."
-          exit 2
-        else
-          Logger.info "<<< Succeeded."
-        end
+        resource.run
+      end
+
+      @delayed_actions.uniq.each do |action, resource|
+        resource.run(action)
       end
     end
 
@@ -37,7 +37,7 @@ module Itamae
     end
 
     def method_missing(method, name, &block)
-      klass = Resources.get_resource_class(method)
+      klass = Resource.get_resource_class(method)
       resource = klass.new(self, name, &block)
       @resources << resource
     end

data/lib/itamae/resource.rb

@@ -0,0 +1,37 @@
+require 'itamae'
+require 'itamae/resource/base'
+require 'itamae/resource/file'
+require 'itamae/resource/package'
+require 'itamae/resource/remote_file'
+require 'itamae/resource/directory'
+require 'itamae/resource/template'
+require 'itamae/resource/execute'
+require 'itamae/resource/mail_alias'
+
+module Itamae
+  module Resource
+    Error = Class.new(StandardError)
+    CommandExecutionError = Class.new(StandardError)
+    AttributeMissingError = Class.new(StandardError)
+    InvalidTypeError = Class.new(StandardError)
+    ParseError = Class.new(StandardError)
+
+    class << self
+      def get_resource_class_name(method)
+        method.to_s.split('_').map {|part| part.capitalize}.join
+      end
+
+      def get_resource_class(method)
+        const_get(get_resource_class_name(method))
+      end
+
+      def parse_description(desc)
+        if /\A([^\[]+)\[([^\]]+)\]\z/ =~ desc
+          [$1, $2]
+        else
+          raise ParseError, "'#{desc}' doesn't represent a resource."
+        end
+      end
+    end
+  end
+end

data/lib/itamae/resource/base.rb

@@ -0,0 +1,257 @@
+require 'itamae'
+require 'shellwords'
+
+module Itamae
+  module Resource
+    class Base
+      @defined_attributes ||= {}
+
+      class << self
+        attr_reader :defined_attributes
+        attr_reader :supported_oses
+
+        def inherited(subclass)
+          subclass.instance_variable_set(
+            :@defined_attributes,
+            self.defined_attributes.dup
+          )
+        end
+
+        def define_attribute(name, options)
+          current = @defined_attributes[name.to_sym] || {}
+          @defined_attributes[name.to_sym] = current.merge(options)
+        end
+      end
+
+      define_attribute :action, type: Symbol, required: true
+
+      attr_reader :resource_name
+      attr_reader :attributes
+      attr_reader :current_attributes
+
+      def initialize(recipe, resource_name, &block)
+        @attributes = {}
+        @current_attributes = {}
+        @recipe = recipe
+        @resource_name = resource_name
+        @notifies = []
+        @subscribes = []
+        @updated = false
+
+        instance_eval(&block) if block_given?
+
+        process_attributes
+      end
+
+      def run(specific_action = nil)
+        Logger.info "> Executing #{resource_type} (#{attributes})..."
+
+        if do_not_run_because_of_only_if?
+          Logger.info "< Execution skipped because of only_if attribute"
+          return
+        elsif do_not_run_because_of_not_if?
+          Logger.info "< Execution skipped because of not_if attribute"
+          return
+        end
+
+        set_current_attributes
+        show_differences
+
+        begin
+          public_send("#{specific_action || action}_action".to_sym)
+        rescue Resource::CommandExecutionError
+          Logger.error "< Failed."
+          exit 2
+        end
+
+        notify if updated?
+
+        Logger.info "< Succeeded."
+      end
+
+      def nothing_action
+        # do nothing
+      end
+
+      def resource_type
+        humps = []
+        self.class.name.split("::").last.each_char do |c|
+          if "A" <= c && c <= "Z"
+            humps << c.downcase
+          else
+            humps.last << c
+          end
+        end
+        humps.join('_')
+      end
+
+      def notifies_resources
+        @notifies.map do |action, resource_desc, timing|
+          resource = resources.find_by_description(resource_desc)
+          [action, resource, timing]
+        end
+      end
+
+      def subscribes_resources
+        @subscribes.map do |action, resource_desc, timing|
+          resource = resources.find_by_description(resource_desc)
+          [action, resource, timing]
+        end
+      end
+
+
+      private
+
+      def method_missing(method, *args)
+        if args.size == 1 && self.class.defined_attributes[method]
+          return @attributes[method] = args.first
+        elsif args.size == 0 && @attributes.has_key?(method)
+          return @attributes[method]
+        end
+        super
+      end
+
+      def set_current_attributes
+      end
+
+      def show_differences
+        @current_attributes.each_pair do |key, current_value|
+          value = @attributes[key]
+          Logger.info "  #{key} will change from '#{current_value}' to '#{value}'"
+        end
+      end
+
+      def process_attributes
+        self.class.defined_attributes.each_pair do |key, details|
+          @attributes[key] ||= @resource_name if details[:default_name]
+          @attributes[key] ||= details[:default]
+
+          if details[:required] && !@attributes[key]
+            raise Resource::AttributeMissingError, "'#{key}' attribute is required but it is not set."
+          end
+
+          if @attributes[key] && details[:type] && !@attributes[key].is_a?(details[:type])
+            raise Resource::InvalidTypeError, "#{key} attribute should be #{details[:type]}."
+          end
+        end
+      end
+
+      def run_specinfra(type, *args)
+        command = Specinfra.command.get(type, *args)
+
+        if type.to_s.start_with?("check_")
+          result = run_command(command, error: false)
+          result.exit_status == 0
+        else
+          run_command(command)
+        end
+      end
+
+      def run_command(command, options = {})
+        options = {error: true}.merge(options)
+
+        result = backend.run_command(command)
+        exit_status = result.exit_status
+
+        if exit_status == 0 || !options[:error]
+          method = :debug
+          message = "  Command `#{command}` exited with #{exit_status}"
+        else
+          method = :error
+          message = "  Command `#{command}` failed. (exit status: #{exit_status})"
+        end
+
+        Logger.public_send(method, message)
+
+        if result.stdout && result.stdout != ''
+          Logger.public_send(method, "  STDOUT> #{result.stdout.chomp}")
+        end
+
+        if result.stderr && result.stderr != ''
+          Logger.public_send(method, "  STDERR> #{result.stderr.chomp}")
+        end
+
+        if options[:error] && exit_status != 0
+          raise CommandExecutionError
+        end
+
+        result
+      end
+
+      def copy_file(src, dst)
+        Logger.debug "  Copying a file from '#{src}' to '#{dst}'..."
+        unless ::File.exist?(src)
+          raise Error, "The file '#{src}' doesn't exist."
+        end
+        backend.copy_file(src, dst)
+      end
+
+      def only_if(command)
+        @only_if_command = command
+      end
+
+      def not_if(command)
+        @not_if_command = command
+      end
+
+      def do_not_run_because_of_only_if?
+        @only_if_command &&
+          run_command(@only_if_command, error: false).exit_status != 0
+      end
+
+      def do_not_run_because_of_not_if?
+        @not_if_command &&
+          run_command(@not_if_command, error: false).exit_status == 0
+      end
+
+      def notifies(action, resource_desc, timing = :delay)
+        @notifies << [action, resource_desc, timing]
+      end
+
+      def subscribes(action, resource_desc, timing = :delay)
+        @subscribes << [action, resource_desc, timing]
+      end
+
+      def node
+        runner.node
+      end
+
+      def backend
+        Itamae.backend
+      end
+
+      def runner
+        @recipe.runner
+      end
+
+      def resources
+        @recipe.resources
+      end
+
+      def shell_escape(str)
+        Shellwords.escape(str)
+      end
+
+      def updated!
+        @updated = true
+      end
+
+      def updated?
+        @updated
+      end
+
+      def notify
+        action_resource_timing = notifies_resources + resources.subscribing(self)
+        action_resource_timing.uniq.each do |action, resource, timing|
+          case timing
+          when :immediately
+            resource.run(action)
+          when :delay
+            @recipe.delayed_actions << [action, resource]
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/itamae/resource/directory.rb

@@ -0,0 +1,35 @@
+require 'itamae'
+
+module Itamae
+  module Resource
+    class Directory < Base
+      define_attribute :action, default: :create
+      define_attribute :path, type: String, default_name: true
+      define_attribute :mode, type: String
+      define_attribute :owner, type: String
+      define_attribute :group, type: String
+
+      def set_current_attributes
+        escaped_path = shell_escape(path)
+        if run_command("test -d #{escaped_path}", error: false).exit_status == 0
+          @current_attributes[:mode] = run_command("stat --format '%a' #{escaped_path}").stdout.chomp
+          @current_attributes[:owner] = run_command("stat --format '%U' #{escaped_path}").stdout.chomp
+          @current_attributes[:group] = run_command("stat --format '%G' #{escaped_path}").stdout.chomp
+        end
+      end
+
+      def create_action
+        if ! run_specinfra(:check_file_is_directory, path)
+          run_specinfra(:create_file_as_directory, path)
+        end
+        if attributes[:mode]
+          run_specinfra(:change_file_mode, path, attributes[:mode])
+        end
+        if attributes[:owner] || attributes[:group]
+          run_specinfra(:change_file_owner, path, attributes[:owner], attributes[:group])
+        end
+      end
+    end
+  end
+end
+

data/lib/itamae/resource/execute.rb

@@ -0,0 +1,16 @@
+require 'itamae'
+
+module Itamae
+  module Resource
+    class Execute < Base
+      define_attribute :action, default: :run
+      define_attribute :command, type: String, default_name: true
+
+      def run_action
+        run_command(command)
+        updated!
+      end
+    end
+  end
+end
+

data/lib/itamae/{resources → resource}/file.rb

@@ -1,15 +1,15 @@
 require 'itamae'
 
 module Itamae
-  module Resources
+  module Resource
     class File < Base
-      define_option :action, default: :create
-      define_option :path, type: String, default_name: true
-      define_option :content, type: String, default: ''
-      define_option :content_file, type: String
-      define_option :mode, type: String
-      define_option :owner, type: String
-      define_option :group, type: String
+      define_attribute :action, default: :create
+      define_attribute :path, type: String, default_name: true
+      define_attribute :content, type: String, default: ''
+      define_attribute :content_file, type: String
+      define_attribute :mode, type: String
+      define_attribute :owner, type: String
+      define_attribute :group, type: String
 
       def create_action
         src = if content_file

data/lib/itamae/resource/mail_alias.rb

@@ -0,0 +1,17 @@
+require 'itamae'
+
+module Itamae
+  module Resource
+    class MailAlias < Base
+      define_attribute :action, default: :create
+      define_attribute :mail_alias, type: String, default_name: true
+      define_attribute :recipient, type: String, required: true
+
+      def create_action
+        if ! backend.check_mail_alias_is_aliased_to(mail_alias, recipient)
+          backend.add_mail_alias(mail_alias, recipient)
+        end
+      end
+    end
+  end
+end

data/lib/itamae/{resources → resource}/package.rb

@@ -1,10 +1,10 @@
 require 'itamae'
 
 module Itamae
-  module Resources
+  module Resource
     class Package < Base
-      define_option :action, default: :install
-      define_option :name, type: String, default_name: true
+      define_attribute :action, default: :install
+      define_attribute :name, type: String, default_name: true
 
       def install_action
         run_specinfra(:install_package, name)

data/lib/itamae/{resources → resource}/remote_file.rb

@@ -1,9 +1,9 @@
 require 'itamae'
 
 module Itamae
-  module Resources
+  module Resource
     class RemoteFile < File
-      define_option :source, type: String, required: true
+      define_attribute :source, type: String, required: true
 
       def create_action
         content_file(::File.expand_path(source, ::File.dirname(@recipe.path)))

data/lib/itamae/{resources → resource}/template.rb

@@ -3,9 +3,9 @@ require 'erb'
 require 'tempfile'
 
 module Itamae
-  module Resources
+  module Resource
     class Template < File
-      define_option :source, type: String, required: true
+      define_attribute :source, type: String, required: true
 
       def create_action
         src = ::File.expand_path(source, ::File.dirname(@recipe.path))

data/lib/itamae/resource_collection.rb

@@ -0,0 +1,27 @@
+module Itamae
+  class ResourceCollection < Array
+    NotFoundError = Class.new(StandardError)
+
+    def find_by_description(desc)
+      # desc is like 'resource_type[name]'
+      self.find do |resource|
+        type, name = Itamae::Resource.parse_description(desc)
+        resource.resource_type == type && resource.resource_name == name
+      end.tap do |resource|
+        unless resource
+          raise NotFoundError, "'#{desc}' resource is not found."
+        end
+      end
+    end
+
+    def subscribing(target)
+      self.map do |resource|
+        resource.subscribes_resources.map do |action, r, timing|
+          if r == target
+            [action, resource, timing]
+          end
+        end.compact
+      end.flatten(1)
+    end
+  end
+end

data/lib/itamae/specinfra.rb

@@ -26,7 +26,7 @@ module Itamae
   private
   def self.create_backend(type)
     Specinfra.configuration.backend = type
-    Itamae.backend = Specinfra.backend
+    Itamae.backend = Specinfra::Runner
   end
 
   module SpecinfraHelpers

data/lib/itamae/version.rb

@@ -1,3 +1,3 @@
 module Itamae
-  VERSION = "1.0.0.beta1"
+  VERSION = "1.0.0.beta2"
 end

data/spec/integration/default_spec.rb

@@ -30,4 +30,26 @@ describe file('/tmp/file') do
   its(:content) { should match(/Hello World/) }
 end
 
+describe file('/tmp/execute') do
+  it { should be_file }
+  its(:content) { should match(/Hello Execute/) }
+end
+
+describe file('/tmp/never_exist1') do
+  it { should_not be_file }
+end
+
+describe file('/tmp/never_exist2') do
+  it { should_not be_file }
+end
+
+describe file('/tmp/notifies') do
+  it { should be_file }
+  its(:content) { should eq("2431") }
+end
+
+describe file('/tmp/subscribes') do
+  it { should be_file }
+  its(:content) { should eq("2431") }
+end
 

data/spec/integration/recipes/default.rb

@@ -4,6 +4,46 @@ end
 
 package 'sl'
 
+######
+
+execute "echo -n > /tmp/notifies"
+
+execute "echo -n 1 >> /tmp/notifies" do
+  action :nothing
+end
+
+execute "echo -n 2 >> /tmp/notifies" do
+  notifies :run, "execute[echo -n 1 >> /tmp/notifies]"
+end
+
+execute "echo -n 3 >> /tmp/notifies" do
+  action :nothing
+end
+
+execute "echo -n 4 >> /tmp/notifies" do
+  notifies :run, "execute[echo -n 3 >> /tmp/notifies]", :immediately
+end
+
+######
+
+execute "echo -n > /tmp/subscribes"
+
+execute "echo -n 1 >> /tmp/subscribes" do
+  action :nothing
+  subscribes :run, "execute[echo -n 2 >> /tmp/subscribes]"
+end
+
+execute "echo -n 2 >> /tmp/subscribes"
+
+execute "echo -n 3 >> /tmp/subscribes" do
+  action :nothing
+  subscribes :run, "execute[echo -n 4 >> /tmp/subscribes]", :immediately
+end
+
+execute "echo -n 4 >> /tmp/subscribes"
+
+######
+
 remote_file "/tmp/remote_file" do
   source "hello.txt"
 end
@@ -22,5 +62,14 @@ file "/tmp/file" do
   content "Hello World"
 end
 
+execute "echo 'Hello Execute' > /tmp/execute"
+
+file "/tmp/never_exist1" do
+  only_if "exit 1"
+end
+
+file "/tmp/never_exist2" do
+  not_if "exit 0"
+end
 
 

data/spec/unit/lib/itamae/{resources → resource}/base_spec.rb

@@ -1,37 +1,37 @@
 require 'itamae'
 
-class DefineOptionTestResource < Itamae::Resources::Base
-  define_option :action, default: :create
-  define_option :default_option, default: :something
-  define_option :required_option, required: true
-  define_option :typed_option, type: Numeric
-  define_option :default_name_option, default_name: true
+class DefineAttributeTestResource < Itamae::Resource::Base
+  define_attribute :action, default: :create
+  define_attribute :default_attribute, default: :something
+  define_attribute :required_attribute, required: true
+  define_attribute :typed_attribute, type: Numeric
+  define_attribute :default_name_attribute, default_name: true
 end
 
-describe DefineOptionTestResource do
-  describe "define_option" do
+describe DefineAttributeTestResource do
+  describe "define_attribute" do
     describe "default" do
       subject do
         described_class.new(double(:recipe), 'resource name') do
-          required_option :required_value
+          required_attribute :required_value
         end
       end
       it "returns the default value" do
-        expect(subject.options[:default_option]).to eq(:something)
+        expect(subject.attributes[:default_attribute]).to eq(:something)
       end
     end
 
     describe "required" do
       subject do
         described_class.new(double(:recipe), 'resource name') do
-          #required_option :required_value
+          #required_attribute :required_value
         end
       end
-      context "without setting required option" do
+      context "without setting required attribute" do
         it "raises an error" do
           expect do
             subject
-          end.to raise_error(Itamae::Resources::OptionMissingError)
+          end.to raise_error(Itamae::Resource::AttributeMissingError)
         end
       end
     end
@@ -40,26 +40,26 @@ describe DefineOptionTestResource do
       context "with correct type value" do
         subject do
           described_class.new(double(:recipe), 'resource name') do
-            required_option :required_value
-            typed_option 10
+            required_attribute :required_value
+            typed_attribute 10
           end
         end
         it "returns the value" do
-          expect(subject.options[:typed_option]).to eq(10)
+          expect(subject.attributes[:typed_attribute]).to eq(10)
         end
       end
 
       context "with incorrect type value" do
         subject do
           described_class.new(double(:recipe), 'resource name') do
-            required_option :required_value
-            typed_option "string"
+            required_attribute :required_value
+            typed_attribute "string"
           end
         end
         it "raises an error" do
           expect do
             subject
-          end.to raise_error(Itamae::Resources::InvalidTypeError)
+          end.to raise_error(Itamae::Resource::InvalidTypeError)
         end
       end
     end
@@ -68,11 +68,11 @@ describe DefineOptionTestResource do
       context "without setting the value" do
         subject do
           described_class.new(double(:recipe), 'resource name') do
-            required_option :required_value
+            required_attribute :required_value
           end
         end
         it "returns the resource name" do
-          expect(subject.options[:default_name_option]).
+          expect(subject.attributes[:default_name_attribute]).
             to eq("resource name")
         end
       end
@@ -80,9 +80,9 @@ describe DefineOptionTestResource do
   end
 end
 
-class TestResource < Itamae::Resources::Base
-  define_option :action, default: :create
-  define_option :option_key, required: false
+class TestResource < Itamae::Resource::Base
+  define_attribute :action, default: :create
+  define_attribute :attribute_key, required: false
 end
 
 describe TestResource do
@@ -116,19 +116,19 @@ describe TestResource do
 
   describe "#run_specinfra" do
     it "runs specinfra's command by specinfra's backend" do
-      expect(Specinfra.command).to receive(:cmd).and_return("command")
+      expect(Specinfra.command).to receive(:get).with(:cmd).and_return("command")
       expect(Itamae.backend).to receive(:run_command).with("command").
         and_return(Specinfra::CommandResult.new(exit_status: 0))
       subject.send(:run_specinfra, :cmd)
     end
     context "when the command execution failed" do
       it "raises CommandExecutionError" do
-        expect(Specinfra.command).to receive(:cmd).and_return("command")
+        expect(Specinfra.command).to receive(:get).with(:cmd).and_return("command")
         expect(Itamae.backend).to receive(:run_command).with("command").
           and_return(Specinfra::CommandResult.new(exit_status: 1))
         expect do
           subject.send(:run_specinfra, :cmd)
-        end.to raise_error(Itamae::Resources::CommandExecutionError)
+        end.to raise_error(Itamae::Resource::CommandExecutionError)
       end
     end
   end

data/spec/unit/lib/itamae/{resources → resource}/package_spec.rb

@@ -1,7 +1,7 @@
 require 'itamae'
 
 module Itamae
-  describe Resources::Package do
+  describe Resource::Package do
     let(:recipe) { double(:recipe) }
     subject(:resource) { described_class.new(recipe, "name") }
 

data/spec/unit/lib/itamae/{resources → resource}/remote_file_spec.rb

@@ -1,7 +1,7 @@
 require 'itamae'
 
 module Itamae
-  describe Resources::RemoteFile do
+  describe Resource::RemoteFile do
     let(:recipe) { double(:recipe) }
     subject(:resource) do
       described_class.new(recipe, "name") do

data/spec/unit/lib/itamae/resource_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Itamae
+  describe Resource do
+    describe ".get_resource_class_name" do
+      let(:method) { :foo_bar_baz }
+      it "returns camel-cased string" do
+        expect(described_class.get_resource_class_name(method)).
+          to eq("FooBarBaz")
+      end
+    end
+
+    describe ".parse_description" do
+      context "with valid description" do
+        it "returns type and name" do
+          expect(described_class.parse_description("this-is_type[this-is_name]")).
+            to eq(["this-is_type", "this-is_name"])
+        end
+      end
+
+      context "with invalid description" do
+        it "raises an error" do
+          expect do
+            described_class.parse_description("[this-is_type][this-is_name]")
+          end.to raise_error(Itamae::Resource::ParseError)
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itamae
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Ryota Arai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta20
+        version: 2.0.0.beta32
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta20
+        version: 2.0.0.beta32
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
@@ -161,13 +175,16 @@ files:
 - lib/itamae/logger.rb
 - lib/itamae/node.rb
 - lib/itamae/recipe.rb
-- lib/itamae/resources.rb
-- lib/itamae/resources/base.rb
-- lib/itamae/resources/directory.rb
-- lib/itamae/resources/file.rb
-- lib/itamae/resources/package.rb
-- lib/itamae/resources/remote_file.rb
-- lib/itamae/resources/template.rb
+- lib/itamae/resource.rb
+- lib/itamae/resource/base.rb
+- lib/itamae/resource/directory.rb
+- lib/itamae/resource/execute.rb
+- lib/itamae/resource/file.rb
+- lib/itamae/resource/mail_alias.rb
+- lib/itamae/resource/package.rb
+- lib/itamae/resource/remote_file.rb
+- lib/itamae/resource/template.rb
+- lib/itamae/resource_collection.rb
 - lib/itamae/runner.rb
 - lib/itamae/specinfra.rb
 - lib/itamae/version.rb
@@ -181,10 +198,10 @@ files:
 - spec/unit/lib/itamae/logger_spec.rb
 - spec/unit/lib/itamae/node_spec.rb
 - spec/unit/lib/itamae/recipe_spec.rb
-- spec/unit/lib/itamae/resources/base_spec.rb
-- spec/unit/lib/itamae/resources/package_spec.rb
-- spec/unit/lib/itamae/resources/remote_file_spec.rb
-- spec/unit/lib/itamae/resources_spec.rb
+- spec/unit/lib/itamae/resource/base_spec.rb
+- spec/unit/lib/itamae/resource/package_spec.rb
+- spec/unit/lib/itamae/resource/remote_file_spec.rb
+- spec/unit/lib/itamae/resource_spec.rb
 - spec/unit/lib/itamae/runner_spec.rb
 - spec/unit/spec_helper.rb
 homepage: https://github.com/ryotarai/itamae
@@ -222,9 +239,9 @@ test_files:
 - spec/unit/lib/itamae/logger_spec.rb
 - spec/unit/lib/itamae/node_spec.rb
 - spec/unit/lib/itamae/recipe_spec.rb
-- spec/unit/lib/itamae/resources/base_spec.rb
-- spec/unit/lib/itamae/resources/package_spec.rb
-- spec/unit/lib/itamae/resources/remote_file_spec.rb
-- spec/unit/lib/itamae/resources_spec.rb
+- spec/unit/lib/itamae/resource/base_spec.rb
+- spec/unit/lib/itamae/resource/package_spec.rb
+- spec/unit/lib/itamae/resource/remote_file_spec.rb
+- spec/unit/lib/itamae/resource_spec.rb
 - spec/unit/lib/itamae/runner_spec.rb
 - spec/unit/spec_helper.rb

data/lib/itamae/resources.rb

@@ -1,25 +0,0 @@
-require 'itamae'
-require 'itamae/resources/base'
-require 'itamae/resources/file'
-require 'itamae/resources/package'
-require 'itamae/resources/remote_file'
-require 'itamae/resources/directory'
-require 'itamae/resources/template'
-
-module Itamae
-  module Resources
-    Error = Class.new(StandardError)
-    CommandExecutionError = Class.new(StandardError)
-    OptionMissingError = Class.new(StandardError)
-    InvalidTypeError = Class.new(StandardError)
-    NotSupportedOsError = Class.new(StandardError)
-
-    def self.get_resource_class_name(method)
-      method.to_s.split('_').map {|part| part.capitalize}.join
-    end
-
-    def self.get_resource_class(method)
-      const_get(get_resource_class_name(method))
-    end
-  end
-end

data/lib/itamae/resources/base.rb

@@ -1,151 +0,0 @@
-require 'itamae'
-require 'shellwords'
-
-module Itamae
-  module Resources
-    class Base
-      @defined_options ||= {}
-      @supported_oses ||= []
-
-      class << self
-        attr_reader :defined_options
-        attr_reader :supported_oses
-
-        def inherited(subclass)
-          subclass.instance_variable_set(
-            :@defined_options,
-            self.defined_options.dup
-          )
-        end
-
-        def define_option(name, options)
-          current = @defined_options[name.to_sym] || {}
-          @defined_options[name.to_sym] = current.merge(options)
-        end
-
-        def support_os(hash)
-          @supported_oses << hash
-        end
-      end
-
-      define_option :action, type: Symbol, required: true
-
-      attr_reader :resource_name
-      attr_reader :options
-
-      def initialize(recipe, resource_name, &block)
-        @options = {}
-        @recipe = recipe
-        @resource_name = resource_name
-
-        instance_eval(&block) if block_given?
-
-        process_options
-        ensure_os
-      end
-
-      def run
-        public_send("#{action}_action".to_sym)
-      end
-
-      def nothing_action
-        # do nothing
-      end
-
-      private
-
-      def method_missing(method, *args)
-        if args.size == 1 && self.class.defined_options[method]
-          return @options[method] = args.first
-        elsif args.size == 0 && @options.has_key?(method)
-          return @options[method]
-        end
-        super
-      end
-
-      def process_options
-        self.class.defined_options.each_pair do |key, details|
-          @options[key] ||= @resource_name if details[:default_name]
-          @options[key] ||= details[:default]
-
-          if details[:required] && !@options[key]
-            raise Resources::OptionMissingError, "'#{key}' option is required but it is not set."
-          end
-
-          if @options[key] && details[:type] && !@options[key].is_a?(details[:type])
-            raise Resources::InvalidTypeError, "#{key} option should be #{details[:type]}."
-          end
-        end
-      end
-
-      def run_specinfra(type, *args)
-        command = Specinfra.command.public_send(type, *args)
-        run_command(command)
-      end
-
-      def run_command(command)
-        result = backend.run_command(command)
-        exit_status = result.exit_status
-
-        if exit_status == 0
-          method = :debug
-          Logger.public_send(method, "Command `#{command}` succeeded")
-        else
-          method = :error
-          Logger.public_send(method, "Command `#{command}` failed. (exit status: #{exit_status})")
-        end
-
-        if result.stdout && result.stdout != ''
-          Logger.public_send(method, "STDOUT> #{result.stdout.chomp}")
-        end
-        if result.stderr && result.stderr != ''
-          Logger.public_send(method, "STDERR> #{result.stderr.chomp}")
-        end
-
-        unless exit_status == 0
-          raise CommandExecutionError
-        end
-      end
-
-      def copy_file(src, dst)
-        Logger.debug "Copying a file from '#{src}' to '#{dst}'..."
-        unless ::File.exist?(src)
-          raise Error, "The file '#{src}' doesn't exist."
-        end
-        unless backend.copy_file(src, dst)
-          raise Error, "Copying a file failed."
-        end
-      end
-
-      def node
-        runner.node
-      end
-
-      def backend
-        Itamae.backend
-      end
-
-      def runner
-        @recipe.runner
-      end
-
-      def shell_escape(str)
-        Shellwords.escape(str)
-      end
-
-      def ensure_os
-        return unless self.class.supported_oses
-        ok = self.class.supported_oses.any? do |supported|
-          supported.each_pair.all? do |k, v|
-            backend.os[k] == v
-          end
-        end
-
-        unless ok
-          raise NotSupportedOsError, "#{self.class.name} resource doesn't support this OS now."
-        end
-      end
-    end
-  end
-end
-

data/lib/itamae/resources/directory.rb

@@ -1,26 +0,0 @@
-require 'itamae'
-
-module Itamae
-  module Resources
-    class Directory < Base
-      define_option :action, default: :create
-      define_option :path, type: String, default_name: true
-      define_option :mode, type: String
-      define_option :owner, type: String
-      define_option :group, type: String
-
-      def create_action
-        if ! backend.check_file_is_directory(path)
-          backend.create_file_as_directory(path)
-        end
-        if options[:mode]
-          backend.change_file_mode(path, options[:mode])
-        end
-        if options[:owner] || options[:group]
-          backend.change_file_owner(path, options[:owner], options[:group])
-        end
-      end
-    end
-  end
-end
-

data/spec/unit/lib/itamae/resources_spec.rb

@@ -1,14 +0,0 @@
-require 'spec_helper'
-
-module Itamae
-  describe Resources do
-    describe "#get_resource_class_name" do
-      let(:method) { :foo_bar_baz }
-      it "returns camel-cased string" do
-        expect(described_class.get_resource_class_name(method)).
-          to eq("FooBarBaz")
-      end
-    end
-  end
-end
-