alx 0.0.1

data/lib/alx/executer.rb

@@ -0,0 +1,13 @@
+module Alx
+
+  module Executer
+
+    def start( cmd )
+      return true if system( "#{cmd}" )
+      raise "Command: #{cmd} failed."
+    end
+
+  end
+
+end
+

data/lib/alx/handler.rb

@@ -0,0 +1,62 @@
+require 'alx/library'
+require 'optparse'
+require 'tempfile'
+
+module Alx
+
+  class Handler
+    attr_reader :command_name
+
+    def initialize( details )
+      @conf = details[ :configuration ]
+      @command_name = details[ :command ]
+
+      @opts = OptionParser.new
+      banner_text = @command_name
+      banner_text += ' [options]' if details[ :options ]
+      banner_text += " <#{details[ :rest_description ]}>" if details[ :rest_description ]
+      banner_text += "\n  #{details[ :description ]}"
+      add_options( details[ :options ] ) if details[ :options ]
+      @opts.banner = banner_text
+    end
+
+    def help
+      @opts.help
+    end
+
+    protected
+    def add_options( opts )
+      opts.each { | o | add_option( o ) }
+    end
+
+    def add_option( opt )
+      case opt
+      when :editor
+        @opts.on( '-e EDITOR', '--editor EDITOR', 'Use EDITOR instead of predefined editor.' ) { | editor | @conf[ :editor ] = editor }
+      when :stdin
+        @opts.on( '-i', '--stdin', 'Use stdin instead of an editor.' ) { @conf.delete( :editor ) }
+      when :stdout
+        @opts.on( '-o', '--stdout', 'Print to stdout instead of starting a viewer.' ) { @conf[ :stdout ] = true }
+      when :html
+        @opts.on( '-h', '--html', 'Generate html from the original text file.' ) { @conf[ :html ] = true }
+      end
+    end
+
+    def parse_options
+      @conf[ :rest ] = @opts.parse( @conf[ :rest ] ).join( ' ' )
+    end
+
+    def options_error( message )
+      puts message
+      puts help
+      raise ""
+    end
+
+    def load_library
+      @lib = Alx::Library.new
+      @lib.load_library( @conf[ :default_shelf_dir ] )
+    end
+  end
+
+end
+

data/lib/alx/help_handler.rb

@@ -0,0 +1,39 @@
+require 'alx/handler'
+
+module Alx
+
+  class HelpHandler < Handler
+    def initialize( configuration, controller )
+      super(
+        :configuration => configuration,
+        :command => 'help',
+        :rest_description => 'command',
+        :description => "Gives more information on defined command." )
+      @controller = controller
+    end
+
+    def handle
+      parse_options
+      handler = @controller.handlers[ @conf[ :rest ] ]
+      if handler
+        puts handler.help
+        return;
+      end
+
+      default_help
+    end
+
+    private
+    def default_help
+      executable_name = File.basename( $PROGRAM_NAME )
+      text = "Usage: #{executable_name} command [options]\n"
+      text += "An easy to use text document manager.\n\n"
+      text += "Commands:\n"
+      @controller.handlers.keys.each { | command | text+="  " + command + "\n" }
+      text += "\nFor more information type: #{executable_name} help <command>"
+      puts text
+    end
+  end
+
+end
+

data/lib/alx/library.rb

@@ -0,0 +1,27 @@
+require 'alx/book'
+
+module Alx
+
+  class Library
+    def initialize
+      @books = []
+    end
+
+    def load_library( directory )
+      Dir.open( directory ) do | dir |
+        files = dir.entries.keep_if { | i | i !~ /^\./ }
+        files.each do | file |
+          @books << Book.new( file.gsub( /_/, " " ), "#{directory}/#{file}" )
+        end
+      end
+      self
+    end
+
+    def list( pattern )
+      @books.select { | book | book.title=~/#{pattern}/ }
+    end
+
+  end
+
+end
+

data/lib/alx/list_handler.rb

@@ -0,0 +1,22 @@
+require 'alx/handler'
+
+module Alx
+
+  class ListHandler < Handler
+    def initialize( configuration )
+      super(
+        :configuration => configuration,
+        :command => 'list',
+        :rest_description => 'pattern',
+        :description => "Lists matching books in the library. Lists all if there's no pattern given." )
+    end
+
+    def handle
+      parse_options
+      load_library.list( @conf[ :rest ] ).each { | book | puts book.title }
+    end
+
+  end
+
+end
+

data/lib/alx/remove_handler.rb

@@ -0,0 +1,36 @@
+require 'alx/handler'
+
+module Alx
+
+  class RemoveHandler < Handler
+    def initialize( configuration )
+      super(
+        :configuration => configuration,
+        :command => 'remove',
+        :rest_description => 'pattern',
+        :description => "Removes matching books from the library." )
+    end
+
+    def handle
+      parse_options
+      options_error( "No pattern given. Please provide one." ) if @conf[ :rest ].empty?
+      matching_books = load_library.list( @conf[ :rest ] )
+      return remove_book( matching_books.pop ) if matching_books.size == 1
+      matching_books.each { | book | remove_book( book ) if ask?( "Do you really want to remove #{book.title}?" ) }
+    end
+
+    private
+    def ask?( message )
+      printf message + " (yes/no) "
+      answer = $stdin.gets.chomp
+      return answer == "yes"
+    end
+
+    def remove_book( book )
+      puts "Removing #{book.title}. A backup is saved to /tmp just in case."
+      FileUtils.mv( book.file_name, "/tmp" )
+    end
+  end
+
+end
+

data/lib/alx/renderer.rb

@@ -0,0 +1,39 @@
+require 'redcarpet'
+
+module Alx
+
+  class Renderer
+    def initialize( conf )
+      @conf = conf
+    end
+
+    def render_to_file( book, destination = nil )
+      on_file( destination ) { | file | file.puts( render( book ) ) }
+    end
+
+    def render( book )
+      if @conf[ :html ]
+        markdown = Redcarpet::Markdown.new( Redcarpet::Render::HTML.new, :fenced_code_blocks => true, :tables => true )
+        return markdown.render( book.content )
+      end
+      book.content
+    end
+
+    private
+    def on_file( destination )
+      file_name = destination ? destination : temp_file
+      File.open( file_name, "w" ) do | file |
+        yield file
+      end
+      file_name
+    end
+
+    def temp_file
+      extension = @conf[ :html ] ? ".html" : ".md"
+      file_name = "/tmp/" + Time.now.to_i.to_s + extension
+    end
+
+  end
+
+end
+

data/lib/alx/show_handler.rb

@@ -0,0 +1,32 @@
+require 'alx/handler'
+require 'alx/renderer'
+require 'alx/viewer'
+
+module Alx
+
+  class ShowHandler < Handler
+    def initialize( configuration )
+      super(
+        :configuration => configuration,
+        :command => 'show',
+        :rest_description => 'pattern',
+        :description => "Shows book matching the given pattern.",
+        :options => [ :html, :stdout ] )
+    end
+
+    def handle
+      parse_options
+      options_error( "No pattern given. Please provide one." ) if @conf[ :rest ].empty?
+      load_library.list( @conf[ :rest ] ).each { | book | show_book( book ) }
+    end
+
+    private
+    def show_book( book )
+      file_name = Renderer.new( @conf ).render_to_file( book )
+      Viewer.new( @conf ).view( file_name )
+    end
+
+  end
+
+end
+

data/lib/alx/version.rb

@@ -0,0 +1,3 @@
+module Alx
+  VERSION = "0.0.1"
+end

data/lib/alx/viewer.rb

@@ -0,0 +1,32 @@
+module Alx
+
+  class Viewer
+    include Executer
+
+    def initialize( conf )
+      @conf = conf
+    end
+
+    def view( file_name )
+      if @conf[ :stdout ]
+        File.open( file_name ) do | file |
+          while line = file.gets
+            $stdout.puts line
+          end
+        end
+
+        return true
+      end
+
+      if @conf[ :html ]
+        start( @conf[ :html_viewer ] + " " + file_name )
+        return true
+      end
+
+      start( @conf[ :terminal_viewer ] + " " + file_name )
+    end
+
+  end
+
+end
+

data/test/tc_book.rb

@@ -0,0 +1,23 @@
+require_relative 'test_helper'
+require 'test/unit'
+require 'alx/book'
+require 'stringio'
+
+class BookTest < Test::Unit::TestCase
+
+  def setup
+    @text = 'something something dark\nside\n'
+    File.stubs( :open ).yields( StringIO.new( @text ) )
+    @book = Alx::Book.new( 'title', 'filename' )
+  end
+
+  def teardown
+    File.unstub( :open )
+  end
+
+  def test_show_content
+    @book.content.should == @text
+  end
+
+end
+

data/test/tc_controller.rb

@@ -0,0 +1,37 @@
+require_relative 'test_helper'
+require 'test/unit'
+require 'alx/controller'
+require 'rspec'
+
+class ControllerTest < Test::Unit::TestCase
+
+  def setup
+    @testconf = {}
+    @controller = Alx::Controller.new( @testconf )
+    @handlers = @controller.handlers
+  end
+
+  def test_constructor_creates_handlers
+    @controller.handlers.should have_key( 'add' )
+    @controller.handlers.should have_key( 'list' )
+    @controller.handlers.should have_key( 'show' )
+    @controller.handlers.should have_key( 'remove' )
+    @controller.handlers.should have_key( 'help' )
+  end
+
+  def test_command_handler_should_be_called_if_exists
+    @testconf[ :command ] = 'help'
+    @handlers[ 'help' ] = HandlerStub.new( @testconf )
+    @controller.run()
+    @handlers[ 'help' ].handle_called.should == true
+  end
+
+  def test_help_handler_should_be_called_if_command_does_not_exist
+    @testconf[ :command ] = 'somethingsomethingdarkside'
+    @handlers[ 'help' ] = HandlerStub.new( @testconf )
+    lambda { @controller.run() }.should raise_error
+    @handlers[ 'help' ].handle_called.should == true
+  end
+
+end
+

data/test/tc_editor.rb

@@ -0,0 +1,42 @@
+require_relative 'test_helper'
+require 'test/unit'
+require 'alx/editor'
+
+class EditorTest < Test::Unit::TestCase
+
+  def setup
+    @conf = Hash.new
+    @editor = Alx::Editor.new( @conf )
+    @file_output = StringIO.new
+    File.stubs( :open ).yields( @file_output )
+  end
+
+  def teardown
+    File.unstub( :open )
+  end
+
+  def test_editor_error
+    @conf[ :editor ] = DUMMY_EXEC
+    lambda { @editor.edit( '/tmp/some_file' ) }.should raise_error
+  end
+
+  def test_editor_returns_false
+    @conf[ :editor ] = FALSE_EXEC
+    lambda { @editor.edit( '/tmp/some_file' ) }.should raise_error
+  end
+
+  def test_editor_success
+    @conf[ :editor ] = TRUE_EXEC
+    lambda { @editor.edit( '/tmp/some_file' ) }.should_not raise_error
+  end
+
+  def test_stdin
+    text_to_write = "some string"
+    stub_in_and_out( text_to_write ) do
+      lambda { @editor.edit( '/tmp/some_file' ) }.should_not raise_error
+    end.should =~ /Reading.*from.*standard.*input/
+    @file_output.string.chomp.should == text_to_write
+  end
+
+end
+

data/test/tc_library.rb

@@ -0,0 +1,33 @@
+require_relative 'test_helper'
+require 'test/unit'
+require 'alx/library'
+require 'alx/book'
+
+class LibraryTest < Test::Unit::TestCase
+
+  def setup_dir( dir )
+    dir.entries << "first_file"
+    dir.entries << "almost_first_file"
+    dir.entries << "second_file"
+  end
+
+  def setup
+    @directory = 'something'
+    @dir_stub = DirStub.new
+    setup_dir( @dir_stub )
+    Dir.stubs( :open ).yields( @dir_stub )
+    @library = Alx::Library.new.load_library( @directory )
+  end
+
+  def teardown
+    Dir.unstub( :open )
+  end
+
+  def test_list_pattern
+    books = @library.list( 'first' )
+    books.size.should == 2
+    books[ 0 ].title.should == @dir_stub.entries[ 0 ].gsub( /_/, ' ' )
+  end
+
+end
+