tweetwine 0.4.1 → 0.4.2

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+=== 0.4.2 released 2011-05-18
+
+* Fail graciously if config file is invalid
+* Removed setting deprecated gemspec attribute (has_rdoc)
+* Cleaned tests
+
 === 0.4.1 released 2011-03-23
 
 * Handle socket errors just like connection errors

data/Rakefile

@@ -3,14 +3,15 @@
 require File.expand_path('project', File.dirname(__FILE__))
 
 require 'rake/clean'
+require 'shellwords'
 
 namespace :gem do
-  CLOBBER.include "#{Project.name}-*.gem"
+  CLOBBER.include "#{Project.spec[:name]}-*.gem"
 
-  current_gem = "#{Project.name}-#{Project.version}.gem"
+  current_gem = "#{Project.spec[:name]}-#{Project.spec[:version]}.gem"
 
   file current_gem do |f|
-    sh %{gem build #{Project.name}.gemspec}
+    sh %{gem build #{Project.spec[:name]}.gemspec}
   end
 
   desc "Package the software as a gem"
@@ -23,62 +24,60 @@ namespace :gem do
 
   desc "Uninstall the gem"
   task :uninstall => :clean do
-    sh %{gem uninstall #{Project.name}}
+    sh %{gem uninstall #{Project.spec[:name]}}
   end
 end
 
 namespace :man do
-  CLOBBER.include "#{Project.dirs.man}/#{Project.name}.?", "#{Project.dirs.man}/#{Project.name}.?.html"
+  CLOBBER.include "#{Project.dirs[:man]}/#{Project.spec[:name]}.?", "#{Project.dirs[:man]}/#{Project.spec[:name]}.?.html"
 
   desc "Build the manual"
   task :build do
-    sh %{ronn -br5 --manual='#{Project.name.capitalize} Manual' --organization='#{Project.authors.first}' #{Project.dirs.man}/*.ronn}
+    sh %{ronn -br5 --manual='#{Project.spec[:name].capitalize} Manual' --organization='#{Project.spec[:authors].first}' #{Project.dirs[:man]}/*.ronn}
   end
 
   desc "Show the manual section 7"
   task :show => :build do
-    sh %{man #{Project.dirs.man}/#{Project.name}.7}
+    sh %{man #{Project.dirs[:man]}/#{Project.spec[:name]}.7}
   end
 end
 
-CLOBBER.include Project.dirs.rdoc
+CLOBBER.include Project.dirs[:rdoc]
 
 desc "Generate RDoc"
 task :rdoc do
-  sh %{rdoc --encoding=UTF-8 --line-numbers --title='#{Project.title}' --output=#{Project.dirs.rdoc} *.rdoc LICENSE.txt lib}
+  sh %{rdoc --encoding=UTF-8 --line-numbers --title='#{Project.extra[:title]}' --output=#{Project.dirs[:rdoc]} *.rdoc LICENSE.txt lib}
 end
 
 namespace :test do
   def create_test_task(type, options = {})
     base_dir  = options[:base_dir]
-    file_glob = options[:file_glob]
+    file_glob = options[:file_glob] || '**/*_test.rb'
     test_desc = options[:desc] || "Run #{type} tests"
-    includes  = ['lib', Project.dirs.test, base_dir].map { |dir| "-I #{dir}" }.join(' ')
+    includes  = ['lib', Project.dirs[:test]].map { |dir| "-I #{dir}" }.join(' ')
     warn_opt  = options[:warn] ? '-w' : ''
 
     desc test_desc
     task type do
-      file_name_offset = base_dir.size + 1
+      file_name_offset = Project.dirs[:test].size + 1
       neg_dotrb_suffix = -'.rb'.size - 1
-      tests = FileList["#{base_dir}/#{file_glob}"].
-          map { |file| '"' << file[file_name_offset..neg_dotrb_suffix] << '"' }.
-          join(' ')
+      tests = Dir["#{base_dir}/#{file_glob}"].
+          map { |file| file[file_name_offset..neg_dotrb_suffix] }.
+          shelljoin
       sh %{bundle exec ruby #{warn_opt} #{includes} -e 'ARGV.each { |f| require f }' #{tests}}
     end
   end
 
   create_test_task :unit,
-      :base_dir   => "#{Project.dirs.test}/unit",
-      :file_glob  => '**/*_test.rb',
+      :base_dir   => "#{Project.dirs[:test]}/unit",
       :warn       => true
-  create_test_task :example,
-      :base_dir   => "#{Project.dirs.test}/example",
-      :file_glob  => '**/*_example.rb',
-      :desc       => 'Run integration/example tests',
+
+  create_test_task :integration,
+      :base_dir   => "#{Project.dirs[:test]}/integration",
       :warn       => false
 
   desc "Run all tests"
-  task :all => [:unit, :example]
+  task :all => [:unit, :integration]
 end
 
 desc "Find code smells"
@@ -88,7 +87,7 @@ end
 
 desc "Show parts of the project tagged as incomplete"
 task :todo do
-  FileList["**/*.*"].egrep /(TODO|FIXME)/
+  FileList["**/*.*"].egrep(/(TODO|FIXME)/)
 end
 
 task :default => :"test:all"

data/lib/tweetwine/cli.rb

@@ -108,8 +108,10 @@ module Tweetwine
       private
 
       def init(args, overriding_default_conf = nil)
-        @config, @http, @oauth, @twitter, @ui, @url_shortener = nil   # reset
+        @config, @http, @oauth, @twitter, @url_shortener = nil  # reset
+        @ui = UI.new                                            # preload with defaults if config init fails
         @config = read_config(args, overriding_default_conf)
+        @ui = nil                                               # reset, reload lazily with real config
       end
 
       def run(args)
@@ -137,113 +139,112 @@ module Tweetwine
         options
       end
     end
-  end
 
-  class Command
-    class << self
-      def inherited(child)
-        # Silence warnings about uninitialized variables if a child does not
-        # set its about, name, or usage.
-        child.instance_eval do
-          @about, @name, @usage = nil
+    class Command
+      class << self
+        def inherited(child)
+          # Silence warnings about uninitialized variables if a child does not
+          # set its about, name, or usage.
+          child.instance_eval do
+            @about, @name, @usage = nil
+          end
         end
-      end
 
-      def about(description = nil)
-        return @about unless description
-        @about = description.chomp
-      end
+        def about(description = nil)
+          return @about unless description
+          @about = description.chomp
+        end
 
-      def register(*names)
-        @name = names.first
-        CLI.register_command(self, names)
-      end
+        def register(*names)
+          @name = names.first
+          CLI.register_command(self, names)
+        end
 
-      def name
-        @name
-      end
+        def name
+          @name
+        end
 
-      # Usage description for the command, use if overriding #parse.
-      def usage(description = nil)
-        return @usage unless description
-        @usage = description
-      end
+        # Usage description for the command, use if overriding #parse.
+        def usage(description = nil)
+          return @usage unless description
+          @usage = description
+        end
 
-      def show_usage(about_cmd = self)
-        about = about_cmd.about
-        name = about_cmd.name
-        usage = about_cmd.usage
-        result = <<-END
+        def show_usage(about_cmd = self)
+          about = about_cmd.about
+          name = about_cmd.name
+          usage = about_cmd.usage
+          result = <<-END
 #{about}
 
 Usage: #{CLI::EXEC_NAME} #{name} #{usage}
-        END
-        CLI.ui.info result.strip!
-      end
+          END
+          CLI.ui.info result.strip!
+        end
 
-      def abort_with_usage
-        show_usage
-        exit CommandLineError.status_code
+        def abort_with_usage
+          show_usage
+          exit CommandLineError.status_code
+        end
       end
-    end
 
-    def initialize(args)
-      parsing_succeeded = parse(args)
-      self.class.abort_with_usage unless parsing_succeeded
-    end
+      def initialize(args)
+        parsing_succeeded = parse(args)
+        self.class.abort_with_usage unless parsing_succeeded
+      end
 
-    # Default behavior, which succeeds always; override for real argument
-    # parsing if the command needs arguments.
-    def parse(args)
-      true
+      # Default behavior, which succeeds always; override for real argument
+      # parsing if the command needs arguments.
+      def parse(args)
+        true
+      end
     end
-  end
 
-  class HelpCommand < Command
-    register "help"
-    about "Show help and exit. Try it with <command> argument."
-    usage <<-END
+    class HelpCommand < Command
+      register "help"
+      about "Show help and exit. Try it with <command> argument."
+      usage <<-END
 [<command>]
 
   If <command> is given, show specific help about that command. If no
   <command> is given, show general help.
-    END
-
-    def parse(args)
-      # Did we arrive here via '-h' option? If so, we cannot have
-      # +proposed_command+ because '-h' does not take an argument. Otherwise,
-      # try to read the argument.
-      proposed_command = args.include?('-h') ? nil : args.shift
-      if proposed_command
-        @command = CLI.find_command proposed_command
-        CLI.ui.error "unknown command: #{proposed_command}\n\n" unless @command
-        @command
-      else
-        @command = nil
-        true
+      END
+
+      def parse(args)
+        # Did we arrive here via '-h' option? If so, we cannot have
+        # +proposed_command+ because '-h' does not take an argument. Otherwise,
+        # try to read the argument.
+        proposed_command = args.include?('-h') ? nil : args.shift
+        if proposed_command
+          @command = CLI.find_command proposed_command
+          CLI.ui.error "unknown command: #{proposed_command}\n\n" unless @command
+          @command
+        else
+          @command = nil
+          true
+        end
       end
-    end
 
-    def run
-      if @command
-        show_command_help
-      else
-        show_general_help
+      def run
+        if @command
+          show_command_help
+        else
+          show_general_help
+        end
       end
-    end
 
-    private
+      private
 
-    def show_command_help
-      self.class.show_usage @command
-    end
+      def show_command_help
+        self.class.show_usage @command
+      end
 
-    def show_general_help
-      command_descriptions = CLI.commands[:primaries].
-        entries.
-        sort     { |a, b| a.first.to_s <=> b.first.to_s }.
-        map      { |cmd, klass| [cmd, klass.about] }
-      CLI.ui.info <<-END
+      def show_general_help
+        command_descriptions = CLI.commands[:primaries].
+          entries.
+          sort     { |a, b| a.first.to_s <=> b.first.to_s }.
+          map      { |cmd, klass| [cmd, klass.about] }
+        CLI.ui.info <<-END
 #{Tweetwine.summary}
 
 Usage: #{CLI::EXEC_NAME} [global_options...] [<command>] [command_options...]
@@ -255,130 +256,131 @@ Usage: #{CLI::EXEC_NAME} [global_options...] [<command>] [command_options...]
   Commands:
 
 #{command_descriptions.map { |cmd, desc| "    %-14s%s" % [cmd, desc] }.join("\n") }
-      END
+        END
+      end
     end
-  end
 
-  class HomeCommand < Command
-    register "home", "h"
-    about "Show authenticated user's home timeline (the default command)."
+    class HomeCommand < Command
+      register "home", "h"
+      about "Show authenticated user's home timeline (the default command)."
 
-    def run
-      CLI.twitter.home
+      def run
+        CLI.twitter.home
+      end
     end
-  end
 
-  class FollowersCommand < Command
-    register "followers", "fo"
-    about "Show authenticated user's followers and their latest tweets."
+    class FollowersCommand < Command
+      register "followers", "fo"
+      about "Show authenticated user's followers and their latest tweets."
 
-    def run
-      CLI.twitter.followers
+      def run
+        CLI.twitter.followers
+      end
     end
-  end
 
-  class FriendsCommand < Command
-    register "friends", "fr"
-    about "Show authenticated user's friends and their latest tweets."
+    class FriendsCommand < Command
+      register "friends", "fr"
+      about "Show authenticated user's friends and their latest tweets."
 
-    def run
-      CLI.twitter.friends
+      def run
+        CLI.twitter.friends
+      end
     end
-  end
 
-  class MentionsCommand < Command
-    register "mentions", "men", "m"
-    about "Show latest tweets that mention or are replies to the authenticated user."
+    class MentionsCommand < Command
+      register "mentions", "men", "m"
+      about "Show latest tweets that mention or are replies to the authenticated user."
 
-    def run
-      CLI.twitter.mentions
+      def run
+        CLI.twitter.mentions
+      end
     end
-  end
 
-  class SearchCommand < Command
-    def self.parser
-      @parser ||= OptionParser.new do |parser, options|
-        parser.on '-a', '--and',  'All words match (default).' do
-          options[:operator] = :and
-        end
-        parser.on '-o', '--or',   'Any word matches.' do
-          options[:operator] = :or
+    class SearchCommand < Command
+      def self.parser
+        @parser ||= OptionParser.new do |parser, options|
+          parser.on '-a', '--and',  'All words match (default).' do
+            options[:operator] = :and
+          end
+          parser.on '-o', '--or',   'Any word matches.' do
+            options[:operator] = :or
+          end
         end
       end
-    end
 
-    register "search", "s"
-    about "Search latest public tweets."
-    usage(Promise.new {<<-END
+      register "search", "s"
+      about "Search latest public tweets."
+      usage(Promise.new {<<-END
 [--all | --or] <word>...
 
   Command options:
 
 #{parser.help}
-      END
-    })
-
-    def parse(args)
-      options = self.class.parser.parse(args)
-      @operator = options[:operator]
-      @words = args
-      if @words.empty?
-        CLI.ui.error "No search words.\n\n"
-        false
-      else
-        true
+        END
+      })
+
+      def parse(args)
+        options = self.class.parser.parse(args)
+        @operator = options[:operator]
+        @words = args
+        if @words.empty?
+          CLI.ui.error "No search words.\n\n"
+          false
+        else
+          true
+        end
       end
-    end
 
-    def run
-      CLI.twitter.search @words, @operator
+      def run
+        CLI.twitter.search @words, @operator
+      end
     end
-  end
 
-  class UpdateCommand < Command
-    register "update", "up"
-    about "Send new tweet."
-    usage <<-END
+    class UpdateCommand < Command
+      register "update", "up"
+      about "Send new tweet."
+      usage <<-END
 [<status>]
 
   If <status> is not given, read the contents for the tweet from STDIN.
-    END
+      END
 
-    def parse(args)
-      @msg = args.join(' ')
-      args.clear
-      true
-    end
+      def parse(args)
+        @msg = args.join(' ')
+        args.clear
+        true
+      end
 
-    def run
-      CLI.twitter.update @msg
+      def run
+        CLI.twitter.update @msg
+      end
     end
-  end
 
-  class UserCommand < Command
-    register "user", "usr"
-    about "Show user's timeline."
-    usage <<-END
+    class UserCommand < Command
+      register "user", "usr"
+      about "Show user's timeline."
+      usage <<-END
 [<username>]
 
   If <username> is not given, show authenticated user's timeline.
-    END
+      END
 
-    def parse(args)
-      @user = args.empty? ? CLI.config[:username] : args.shift
-    end
+      def parse(args)
+        @user = args.empty? ? CLI.config[:username] : args.shift
+      end
 
-    def run
-      CLI.twitter.user(@user)
+      def run
+        CLI.twitter.user(@user)
+      end
     end
-  end
 
-  class VersionCommand < Command
-    register "version", "ver", "v"
-    about "Show program version and exit."
+    class VersionCommand < Command
+      register "version", "ver", "v"
+      about "Show program version and exit."
 
-    def run
-      CLI.ui.info "tweetwine #{Tweetwine.version}"
+      def run
+        CLI.ui.info "tweetwine #{Tweetwine.version}"
+      end
     end
   end
 end

data/lib/tweetwine/config.rb

@@ -58,8 +58,9 @@ module Tweetwine
     end
 
     def self.parse_config_file(config_file)
-      options = File.open(config_file, 'r') { |io| YAML.load(io) }
-      Support.symbolize_hash_keys(options)
+      config = YAML.load_file config_file
+      raise ConfigError, "invalid config file; it must be a mapping style YAML document: #{config_file}" unless config.is_a? Hash
+      Support.symbolize_hash_keys(config)
     end
   end
 end

data/lib/tweetwine/exceptions.rb

@@ -15,6 +15,7 @@ module Tweetwine
     end
   end
 
+  class ConfigError         < Error; status_code(12); end
   class CommandLineError    < Error; status_code(13); end
   class UnknownCommandError < Error; status_code(14); end
 

data/lib/tweetwine/version.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 module Tweetwine
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.4.2'.freeze
 
   class << self
     def version

data/project.rb

@@ -1,30 +1,30 @@
 # coding: utf-8
 
-require 'ostruct'
-
 name = 'tweetwine'
 $LOAD_PATH.unshift File.expand_path('lib', File.dirname(__FILE__))
 require "#{name}/version"
 
-Project = OpenStruct.new({
-  :name         => name,
-  :version      => Tweetwine.version.dup,
-  :summary      => Tweetwine.summary,
-  :description  => '',
-  :email        => 'tkareine@gmail.com',
-  :homepage     => 'https://github.com/tkareine/tweetwine',
-  :authors      => ['Tuomas Kareinen'],
-  :dirs         => OpenStruct.new({
+Project = Struct.new('Project', :spec, :dirs, :extra).new(
+  {
+    :name         => name,
+    :version      => Tweetwine.version.dup,
+    :summary      => Tweetwine.summary,
+    :description  => '',
+    :email        => 'tkareine@gmail.com',
+    :homepage     => 'https://github.com/tkareine/tweetwine',
+    :authors      => ['Tuomas Kareinen']
+  },
+  {
     :man  => 'man',
     :rdoc => 'rdoc',
     :test => 'test'
-  }).freeze
-})
+  },
+  {}
+)
 
-Project.description = <<-END
+Project.spec[:description] = <<-END
 A simple but tasty Twitter agent for command line use, designed for quickly
 showing the latest tweets.
   END
-Project.title = "#{Project.name} #{Project.version}"
 
-Project.freeze
+Project.extra[:title] = "#{Project.spec[:name]} #{Project.spec[:version]}"

data/test/fixture/oauth.rb

@@ -4,17 +4,17 @@ module Tweetwine::Test
 
 module Fixture
   module OAuth
-    METHOD = :post
-    REQUEST_TOKEN_KEY = 'ManManManManManManManManManManManManManM'
-    REQUEST_TOKEN_SECRET = '3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3'
-    REQUEST_TOKEN_RESPONSE = "oauth_token=#{REQUEST_TOKEN_KEY}&oauth_token_secret=#{REQUEST_TOKEN_SECRET}&oauth_callback_confirmed=true"
-    REQUEST_TOKEN_URL = 'https://api.twitter.com/oauth/request_token'
-    ACCESS_TOKEN_KEY = '111111111-XyzXyzXyzXyzXyzXyzXyzXyzXyzXyzXyzXyzXyzX'
-    ACCESS_TOKEN_SECRET = '4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x'
-    ACCESS_TOKEN_RESPONSE = "oauth_token=#{ACCESS_TOKEN_KEY}&oauth_token_secret=#{ACCESS_TOKEN_SECRET}&user_id=42&screen_name=fooman"
-    ACCESS_TOKEN_URL = 'https://api.twitter.com/oauth/access_token'
-    AUTHORIZE_URL = "https://api.twitter.com/oauth/authorize?oauth_token=#{REQUEST_TOKEN_KEY}"
-    PIN = '12345678'
+    METHOD                  = :post
+    REQUEST_TOKEN_KEY       = 'ManManManManManManManManManManManManManM'
+    REQUEST_TOKEN_SECRET    = '3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3x3'
+    REQUEST_TOKEN_RESPONSE  = "oauth_token=#{REQUEST_TOKEN_KEY}&oauth_token_secret=#{REQUEST_TOKEN_SECRET}&oauth_callback_confirmed=true"
+    REQUEST_TOKEN_URL       = 'https://api.twitter.com/oauth/request_token'
+    ACCESS_TOKEN_KEY        = '111111111-XyzXyzXyzXyzXyzXyzXyzXyzXyzXyzXyzXyzXyzX'
+    ACCESS_TOKEN_SECRET     = '4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x4x'
+    ACCESS_TOKEN_RESPONSE   = "oauth_token=#{ACCESS_TOKEN_KEY}&oauth_token_secret=#{ACCESS_TOKEN_SECRET}&user_id=42&screen_name=fooman"
+    ACCESS_TOKEN_URL        = 'https://api.twitter.com/oauth/access_token'
+    AUTHORIZE_URL           = "https://api.twitter.com/oauth/authorize?oauth_token=#{REQUEST_TOKEN_KEY}"
+    PIN                     = '12345678'
   end
 end