automatic 12.3.0 → 12.3.1

data/lib/automatic/pipeline.rb

@@ -3,7 +3,7 @@
 # Name::      Automatic::Pipeline
 # Author::    774 <http://id774.net>
 # Created::   Feb 22, 2012
-# Updated::   Mar 3, 2012
+# Updated::   Mar 10, 2012
 # Copyright:: 774 Copyright (c) 2012
 # License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
 
@@ -11,23 +11,29 @@ require 'active_support/core_ext'
 
 module Automatic
   module Plugin end
+  class NoPluginError < StandardError; end
+  class NoRecipeError < StandardError; end
 
   module Pipeline
     def self.load_plugin(module_name)
-      Dir.foreach(Automatic.plugins_dir) do |subdir|
-        if /^#{subdir}_(.*)$/ =~ module_name.underscore
-          path = Automatic.plugins_dir + subdir + "/#{$1}.rb"
-          Automatic::Plugin.autoload module_name.to_sym, path.to_s
+      Dir[Automatic.user_plugins_dir + "/*",
+          Automatic.plugins_dir + "/*"].each{ |dir|
+        subdir = File.basename dir
+        if /#{subdir}_(.*)$/ =~ module_name.underscore
+          path = dir + "/#{$1}.rb"        
+          return Automatic::Plugin.autoload module_name.to_sym, path.to_s if File.exists? path
         end
-      end
+      }
+      raise NoPluginError, "unknown plugin named #{module_name}"
     end
- 
+
     def self.run(recipe)
-      raise "NoRecipeError" if recipe.nil?
+      raise NoRecipeError if recipe.nil?
       pipeline = []
       recipe.each_plugin { |plugin|
-        load_plugin(plugin.module)
-        klass = Automatic::Plugin.const_get(plugin.module)
+        mod = plugin.module
+        load_plugin(mod)
+        klass = Automatic::Plugin.const_get(mod)
         pipeline = klass.new(plugin.config, pipeline).run
       }
     end

data/lib/automatic/recipe.rb

@@ -1,8 +1,8 @@
 # Name::      Automatic::Recipe
-# Author::    774 <http://id774.net>
+# Author::    ainame
 # Version::   12.02-devel
 # Created::   Feb 18, 2012
-# Updated::   Feb 24, 2012
+# Updated::   Mar 12, 2012
 # Copyright:: 774 Copyright (c) 2012
 # License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
 
@@ -13,8 +13,7 @@ module Automatic
   class Recipe
     attr_reader :procedure
 
-    def initialize(path)
-      path = Automatic.config_dir + 'default.yml' if path.to_s.empty?
+    def initialize(path = "")
       load_recipe(path)
     end
 

data/lib/automatic.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Name::      Automatic::Ruby
 # Author::    774 <http://id774.net>
-# Version::   12.03
+# Version::   12.3.1
 # Created::   Feb 18, 2012
-# Updated::   Mar  7, 2012
+# Updated::   Mar 15, 2012
 # Copyright:: 774 Copyright (c) 2012
 # License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
 
@@ -14,47 +14,41 @@ module Automatic
   require 'automatic/log'
   require 'automatic/feed_parser'
 
-  VERSION = "12.03"
+  VERSION = "12.3.1"
+  USER_DIR = "/.automatic"
 
-  def self.root_dir
-    @root_dir
-  end
+  class << self
+    attr_accessor :root_dir
 
-  def self.plugins_dir
-    @root_dir + "/plugins/"
-  end
+    def run(args = { })
+      self.root_dir = args[:root_dir]
+      self.user_dir = args[:user_dir]
+      Automatic::Pipeline.run(args[:recipe])
+    end
+    
+    def plugins_dir
+      File.join(@root_dir, "plugins")
+    end
 
-  def self.config_dir
-    @root_dir + "/config/"
-  end
+    def config_dir
+      File.join(@root_dir, "config")
+    end
+
+    def user_dir
+      @user_dir
+    end
 
-  def self.run(root_dir)
-    @root_dir = root_dir
-    recipe_path = ""
-    require 'optparse'
-    parser = OptionParser.new { |parser|
-      parser.banner = "Usage: automatic [options] arg"
-      parser.version = VERSION
-      parser.separator "options:"
-      parser.on('-c', '--config FILE', String,
-                "recipe YAML file"){|c| recipe_path = c}
-      parser.on('-h', '--help', "show this message") { 
-        puts parser
-        exit
-      }
-    }
-
-    begin
-      parser.parse!
-      print "Loading #{recipe_path}\n" unless recipe_path == ""
-    rescue OptionParser::ParseError => err
-      $stderr.puts err.message
-      $stderr.puts parser.help
-      exit 1
+    def user_dir=(_user_dir)
+      if ENV["AUTOMATIC_RUBY_ENV"] == "test" && !(_user_dir.nil?)
+        @user_dir = _user_dir 
+      else
+        @user_dir = File.expand_path("~/") + USER_DIR
+      end
     end
 
-    # recipe treat as an object.
-    recipe = Automatic::Recipe.new(recipe_path)
-    Automatic::Pipeline.run(recipe)
+    def user_plugins_dir
+      File.join(@user_dir, "plugins")
+    end
   end
+
 end

data/lib/config/validator.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+# Name::      Automatic::Config::Validator
+# Author::    aerith <http://aerith.sc/>
+# Created::   Feb 23, 2012
+# Updated::   Feb 23, 2012
+# Copyright:: Copyright (c) 2012
+# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+
+class Automatic
+  module Config
+    class Validator
+      attr_accessor :config, :result
+
+      class InvalidException < Exception; end;
+
+      def initialize(config = nil)
+        @config = config || {}
+        @result = ValidateResult.new
+      end
+
+      def validate(klass, config = nil)
+        return true if config.nil?
+        return true if not config.is_a?(Hash)
+        return true if not klass.respond_to?(:rules)
+
+        rules = klass.rules
+        return true if not rules.is_a?(Hash)
+
+        process(rules, config).result.valid?
+      end
+
+      private
+      def process(rules, config)
+        errors = {}
+
+        rules.each do |key, rule|
+          name = key.to_sym
+
+          rule.each do |method, args|
+            unless ValidateRule.send(method, *[config, name, args])
+              errors[name] = {} if errors[name].nil? or errors.size < 1
+              errors[name][method] = true
+              if @config["stop_on_invalid"] and errors[name][method]
+                raise InvalidException
+              end
+            end
+          end
+        end
+
+        @result.errors = errors
+
+        self
+      end
+
+      class ValidateResult
+        attr_accessor :errors
+
+        def error(name)
+          errors.exists?(name)
+        end
+
+        def valid?
+          errors.empty?
+        end
+      end
+
+      module ValidateRule
+        def self.required(config, name, *args)
+          return true unless args.size < 1 or args.first
+          return true if not config[name.to_s].nil? and not config[name.to_s].empty?
+          false
+        end
+
+        def self.default(config, name, *args)
+          config[name.to_s] ||= args.first 
+          true
+        end
+      end
+    end
+  end
+end
+

data/plugins/custom_feed/svn_log.rb

@@ -39,7 +39,7 @@ module Automatic::Plugin
     def base_url
       return @config['target'].gsub(/\/$/, "")
     end
-    
+
     def svn_log_argument
       return [
         base_url,

data/plugins/filter/ignore.rb

@@ -3,7 +3,7 @@
 # Name::      Automatic::Plugin::Filter::Ignore
 # Author::    774 <http://id774.net>
 # Created::   Feb 22, 2012
-# Updated::   Mar  4, 2012
+# Updated::   Mar  8, 2012
 # Copyright:: 774 Copyright (c) 2012
 # License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
 
@@ -32,6 +32,14 @@ module Automatic::Plugin
           end
         }
       end
+      unless @config['exclude'].nil?
+        @config['exclude'].each {|e|
+          if items.link.include?(e.chomp)
+            detection = true 
+            Automatic::Log.puts("info", "Excluded by link: #{items.link}")
+          end
+        }
+      end
       unless @config['description'].nil?
         @config['description'].each {|e|
           if items.description.include?(e.chomp)

data/plugins/notify/ikachan.rb

@@ -31,20 +31,21 @@ module Automatic::Plugin
       proxy_class = Net::HTTP::Proxy(ENV["PROXY"], 8080)
       http        = proxy_class.new(uri.host, uri.port)
       http.start do |http|
-        @params['channels'].each do|channel|
-          http.post("/join", "channel=#{channel}") # send join command to make sure when if ikachan is not in the channel
+        @params['channels'].split(",").each do|channel|
+          # send join command to make sure when if ikachan is not in the channel
+          http.post("/join", "channel=#{channel}")
           res = http.post(uri.path, %Q(channel=#{channel}&message=#{message}))
-          t   = Time.now.strftime("%Y/%m/%d %X")
-          if res.code == "200" then
-            puts "#{t} [info] Success: #{message}"
+          if res.code == "200"
+            Automatic::Log.puts(:info, "Success: #{message}")
           else
-            puts "#{t} [error] #{res.code} Error: #{message}"
+            Automatic::Log.puts(:error, "#{res.code} Error: #{message}")
           end
         end
       end
     end
 
     private
+    
     def build_message(link, title)
       message = ""
       message += "#{title.to_s} - " unless title.blank?

data/plugins/publish/hatena_bookmark.rb

@@ -3,7 +3,7 @@
 # Name::      Automatic::Plugin::Publish::HatenaBookmark
 # Author::    774 <http://id774.net>
 # Created::   Feb 22, 2012
-# Updated::   Feb 24, 2012
+# Updated::   Mar 12, 2012
 # Copyright:: 774 Copyright (c) 2012
 # License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
 
@@ -55,19 +55,16 @@ module Automatic::Plugin
       uri = URI.parse(url)
       proxy_class = Net::HTTP::Proxy(ENV["PROXY"], 8080)
       http = proxy_class.new(uri.host)
-      http.start {|http|
+      http.start { |http|
         # b_url = NKF.nkf('-w', b_url)
         # b_comment = NKF.nkf('-w', b_comment)
         res = http.post(uri.path, toXml(b_url, b_comment), header)
-        t = Time.now.strftime("%Y/%m/%d %X")
         if res.code == "201" then
-          unless b_comment.nil?
-            print "#{t} [info] Success: #{b_url} Comment: #{b_comment}\n"
-          else
-            print "#{t} [info] Success: #{b_url}\n"
-          end
+          message = "Success: #{b_url}"
+          message += " Comment: #{b_comment}" unless b_comment.nil?
+          Automatic::Log.puts(:info, message)
         else
-          print "#{t} [error] #{res.code} Error: #{b_url}\n"
+          Automatic::Log.puts(:error, "#{res.code} Error: #{b_url}")
         end
       }
     end

data/script/build

@@ -0,0 +1,63 @@
+#!/bin/sh
+#
+########################################################################
+# Integration Build Script
+#
+#  Maintainer: id774 <idnanashi@gmail.com>
+#
+#  v1.0 3/16,2012
+#       First.
+########################################################################
+
+kickstart() {
+    export RACK_ROOT="."
+    export RACK_ENV="test"
+    export DATABASE_URL="$RACK_ROOT/db"
+    ruby -v
+    test_config log info started.
+}
+
+exec_rspec() {
+    $RACK_ROOT/bin/automatic -v
+    $RACK_ROOT/script/bootstrap
+    bundle exec $RACK_ROOT/bin/rake simplecov
+}
+
+run_test() {
+    while [ $# -gt 0 ]
+    do
+        $RACK_ROOT/bin/automatic -c $1
+        test_config log info $?
+        shift
+    done
+}
+
+load_tests() {
+    for YAML_FILE in "$RACK_ROOT/test/integration/*.yml"
+    do
+        run_test $YAML_FILE
+    done
+    unset YAML_FILE
+}
+
+test_config() {
+    $RACK_ROOT/bin/automatic-config $*
+}
+
+added_tests() {
+    test_config scaffold
+    test_config autodiscovery http://id774.net/blog/
+    test_config opmlparser "$RACK_ROOT/test/fixtures/sampleOPML.xml"
+    test_config feedparser http://id774.net/blog/feed/ > /dev/null
+    test_config log info finished.
+}
+
+main() {
+    kickstart
+    exec_rspec
+    load_tests
+    added_tests
+}
+
+set -ex
+main

data/spec/lib/automatic/pipeline_spec.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# Name::      pipeline_sepc.rb
+# Author::    ainame
+# Created::   Mar 10, 2012
+# Updated::   Mar 10, 2012
+# Copyright:: ainame Copyright (c) 2012
+# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+
+require File.expand_path(File.join(File.dirname(__FILE__) ,'../../spec_helper'))
+require 'automatic'
+require 'automatic/pipeline'
+
+TEST_MODULES = ["SubscriptionFeed", "FilterIgnore"]
+
+describe Automatic::Pipeline do 
+  describe "in default dir" do 
+    before do 
+      Automatic.root_dir = APP_ROOT
+      Automatic.user_dir = nil
+    end
+    
+    describe "#load_plugin" do
+      it "raise no plugin error" do 
+        lambda{ 
+          Automatic::Plugin.load_plugin "FooBar"
+        }.should raise_exception
+      end
+
+      it "correctly load module" do 
+        TEST_MODULES.each do |mod|
+          Automatic::Pipeline.load_plugin mod.to_s
+          Automatic::Plugin.const_get(mod).class.should == Class
+        end
+      end
+    end
+  end
+
+  describe "in user dir" do 
+    before do 
+      Automatic.root_dir = APP_ROOT
+      Automatic.user_dir = File.join(APP_ROOT, "spec/user_dir")
+    end
+
+    describe "#load_plugin" do
+      it "correctly load module" do 
+        # StoreMock is the mock class that it return pipeline.
+        mock = "StoreMock"
+        Automatic::Pipeline.load_plugin mock
+        klass = Automatic::Plugin.const_get(mock)
+        klass.class.should == Class
+        klass.new(nil, ["mock"]).run.should == "mock"
+      end
+    end
+  end
+end

data/spec/lib/automatic_spec.rb

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# Name::      Automatic
+# Author::    kzgs
+# Created::   Mar  9, 2012
+# Updated::   Mar 10, 2012
+# Copyright:: kzgs Copyright (c) 2012
+# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
+require 'automatic'
+
+describe Automatic do
+  describe "#run" do
+    describe "with a root dir which has default recipe" do
+      specify {
+        lambda{ 
+          Automatic.run(:recipe   => "",
+                        :root_dir => APP_ROOT,
+                        :user_dir => APP_ROOT + "/spec/user_dir")
+        }.should_not raise_exception(Errno::ENOENT)
+      }
+    end
+  end
+
+  describe "#(root|config)_dir" do
+    specify {
+      Automatic.root_dir.should == APP_ROOT
+      Automatic.config_dir.should == APP_ROOT+"/config"
+    }
+  end
+
+  describe "#user_dir= in test env" do 
+    before(:all) do 
+      Automatic.user_dir = File.join(APP_ROOT, "spec/user_dir")
+    end
+
+    describe "#user_dir" do 
+      it "return valid value" do 
+        Automatic.user_dir.should == File.join(APP_ROOT, "spec/user_dir")
+      end
+    end
+
+    describe "#user_plugins_dir" do 
+      it "return valid value" do 
+        Automatic.user_plugins_dir.should == File.join(APP_ROOT, "spec/user_dir/plugins")
+      end
+    end
+
+    after(:all) do 
+      Automatic.user_dir = nil
+    end
+  end
+
+  describe "#set_user_dir in other env" do 
+    before(:all) do 
+      ENV["AUTOMATIC_RUBY_ENV"] = "other"
+      Automatic.user_dir = nil
+    end
+
+    describe "#user_dir" do 
+      it "return valid value" do 
+        Automatic.user_dir.should == File.expand_path("~/") + "/.automatic"
+      end
+    end
+
+    describe "#user_plugins_dir" do 
+      it "return valid value" do 
+        Automatic.user_plugins_dir.should == File.expand_path("~/") + "/.automatic/plugins"
+      end
+    end
+
+    after(:all) do 
+      ENV["AUTOMATIC_RUBY_ENV"] = "test"
+    end
+  end
+
+end

data/spec/lib/pipeline_spec.rb

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+# Name::      pipeline_sepc.rb
+# Author::    ainame
+# Created::   Mar 10, 2012
+# Updated::   Mar 10, 2012
+# Copyright:: ainame Copyright (c) 2012
+# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+
+require File.expand_path(File.join(File.dirname(__FILE__) ,'../spec_helper'))
+require 'automatic'
+require 'automatic/pipeline'
+
+TEST_MODULES = ["SubscriptionFeed", "FilterIgnore"] if TEST_MODULES.nil?
+
+describe Automatic::Pipeline do 
+  describe "in default dir" do 
+    before do 
+      Automatic.root_dir = File.expand_path(File.join(File.dirname(__FILE__), "../../"))
+      Automatic.user_dir = nil
+    end
+    
+    describe "#load_plugin" do
+      it "raise no plugin error" do 
+        lambda{ 
+          Automatic::Pipeline.load_plugin "FooBar"
+        }.should raise_exception(Automatic::NoPluginError,
+          /unknown plugin named FooBar/)
+      end
+
+      it "correctly load module" do 
+        TEST_MODULES.each do |mod|
+          Automatic::Pipeline.load_plugin mod.to_s
+          Automatic::Plugin.const_get(mod).class.should == Class
+        end
+      end
+    end
+
+    describe "#run" do
+      it "run a recipe with FilterIgnore module" do
+        plugin = mock("plugin")
+        plugin.should_receive(:module).and_return("FilterIgnore")
+        plugin.should_receive(:config)
+        recipe = mock("recipe")
+        recipe.should_receive(:each_plugin).and_yield(plugin)
+        Automatic::Pipeline.run(recipe).should == []
+      end
+    end
+  end
+
+  describe "in user dir" do 
+    before do 
+      Automatic.root_dir = File.expand_path(File.join(File.dirname(__FILE__), "../../"))
+      Automatic.user_dir = File.expand_path(File.join(File.dirname(__FILE__), "../user_dir/"))
+    end
+
+    describe "#load_plugin" do
+      it "correctly load module" do 
+        # StoreMock is the mock class that it return pipeline.
+        mock = "StoreMock"
+        Automatic::Pipeline.load_plugin mock
+        klass = Automatic::Plugin.const_get(mock)
+        klass.class.should == Class
+        klass.new(nil, ["mock"]).run.should == "mock"
+      end
+    end
+  end
+end

data/spec/plugins/filter/ignore_spec.rb

@@ -3,6 +3,22 @@ require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
 require 'filter/ignore'
 
 describe Automatic::Plugin::FilterIgnore do
+  context "with exclusion by description" do
+    subject {
+      Automatic::Plugin::FilterIgnore.new({
+        'exclude' => ["comment"],
+      },
+        AutomaticSpec.generate_pipeline {
+          feed { item "http://github.com" }
+          feed { item "http://google.com" }
+        })
+    }
+    
+    describe "#run" do
+      its(:run) { should have(2).feeds }
+    end
+  end
+
   context "with exclusion by description" do
     subject {
       Automatic::Plugin::FilterIgnore.new({

data/spec/plugins/filter/image_spec.rb

@@ -10,7 +10,7 @@ require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
 
 require 'filter/image'
 
-describe Automatic::Plugin::FilterImage do  
+describe Automatic::Plugin::FilterImage do
   context "with description with image tag" do
     subject {
       Automatic::Plugin::FilterImage.new({},
@@ -29,10 +29,10 @@ describe Automatic::Plugin::FilterImage do
         should == "http://27.media.tumblr.com/tumblr_lzrubkfPlt1qb8vzto1_500.png"
       }
     end
-  end  
+  end
 end
 
-describe Automatic::Plugin::FilterImage do  
+describe Automatic::Plugin::FilterImage do
   context "with description with image tag" do
     subject {
       Automatic::Plugin::FilterImage.new({},
@@ -51,5 +51,5 @@ describe Automatic::Plugin::FilterImage do
         should == "http://24.media.tumblr.com/tumblr_m07wttnIdy1qzoj1jo1_400.jpg"
       }
     end
-  end  
+  end
 end