alx 0.0.1

data/README.md

@@ -0,0 +1,5 @@
+# alx
+
+alx is *going to be* an easy to use command line application to handle text based documents
+
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+Cucumber::Rake::Task.new( :ft ) do | t |
+  t.cucumber_opts = "features --format pretty -x"
+  t.fork = false
+end
+
+
+Rake::TestTask.new( "ut" ) do | test |
+  test.test_files = FileList['test/tc_*.rb']
+end
+

data/alx.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alx/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "alx"
+  gem.version       = Alx::VERSION
+  gem.authors       = ["Peter Hajdu"]
+  gem.email         = ["peter.ferenc.hajdu@gmail.com"]
+  gem.description   = %q{Command line tool to manage your markdown documents. ( beta )}
+  gem.summary       = %q{An easy to use command line text document manager. ( beta )}
+  gem.homepage      = "http://github.com/PeterHajdu/alx"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency( 'redcarpet' )
+  gem.add_development_dependency( 'cucumber' )
+  gem.add_development_dependency( 'rspec' )
+  gem.add_development_dependency( 'simplecov' )
+end

data/bin/alx

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby
+
+require 'alx/configuration'
+require 'alx/controller'
+
+begin
+  configuration = Alx::Configuration.new
+  control = Alx::Controller.new( configuration.hash )
+  control.run()
+rescue => exception
+  puts exception.message
+  exit 1
+end
+

data/features/add_books.feature

@@ -0,0 +1,15 @@
+Feature: As a user
+         I would like to add books to the library
+         So that I can read them later
+
+  Scenario: Adding books to the library.
+    Given an empty library
+    When I add the following books
+      | first howto | text 1 |
+      | second howto | text 2 |
+      | and some more | text 3 |
+    Then I should be able to retrieve the following books
+      | first howto | text 1 |
+      | second howto | text 2 |
+      | and some more | text 3 |
+

data/features/create_default_configuration.feature

@@ -0,0 +1,8 @@
+Feature: A default configuration folder hierarchy has to be created
+         if it does not exist already.
+
+  Scenario: Creating default configuration
+    Given there is no configuration
+    When I start alx
+    Then the default configuration should be created
+

data/features/give_meaningful_help.feature

@@ -0,0 +1,8 @@
+Feature: As a user
+         I would like to see meaningful help text
+         So that I can use the software easier
+
+  Scenario: Starting alx for help
+    When I start alx
+    Then I should be able to see a list of available commands
+

data/features/remove_book.feature

@@ -0,0 +1,17 @@
+Feature: As a user
+         I would like to remove books from the library
+
+  Scenario: Removing books from the library.
+    Given I add the following books
+      | first howto | text 1 |
+      | second howto | text 2 |
+      | and some more | text 3 |
+    When I remove the following books
+      | first howto |
+      | second howto |
+    Then I should not be able to retrieve the following books
+      | first howto |
+      | second howto |
+    But I should be able to retrieve the following books
+      | and some more | text 3 |
+

data/features/step_definitions/alx_base_steps.rb

@@ -0,0 +1,36 @@
+Given /^an empty library$/ do
+  cleanup_home
+end
+
+
+When /^I add the following books$/ do | books |
+  books.raw.each do | title, content |
+    ENV['EDITOR'] = "echo #{content} >"
+    add( title )
+  end
+end
+
+
+Then /^I should be able to retrieve the following books$/ do | books |
+  list
+  list_output = @output
+  books.raw.each do | title, content |
+    list_output.should =~ /#{title}/
+    show( title )
+    @output.should =~ /#{content}/
+  end
+end
+
+When /^I remove the following books$/ do | books |
+  books.raw.each do | title |
+    remove( title[ 0 ] )
+  end
+end
+
+Then /^I should not be able to retrieve the following books$/ do | books |
+  list
+  books.raw.each do | title |
+    @output.should_not =~ /#{title[ 0 ]}/
+  end
+end
+

data/features/step_definitions/alx_configuration_steps.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+
+Given /^there is no configuration$/ do
+  cleanup_home
+end
+
+
+When /^I start alx$/ do
+  alx( "", false )
+end
+
+
+Then /^the default configuration should be created$/ do
+  check_directory_presence( lib_dir, true )
+  check_file_presence( conf_file, true )
+  conf = YAML.load_file( conf_file )
+  conf.should == Alx::DEFAULT_CONFIG
+end
+

data/features/step_definitions/alx_help_steps.rb

@@ -0,0 +1,7 @@
+
+Then /^I should be able to see a list of available commands$/ do
+  alx_commands.each do | command |
+    @output.should =~ /#{command}/
+  end
+end
+

data/features/support/alx_extensions.rb

@@ -0,0 +1,67 @@
+require 'alx/controller'
+require 'alx/configuration'
+
+module AlxHelpers
+
+  def add( rest = "", success = true )
+    alx( "add " + rest, success )
+  end
+
+  def remove( rest = "", success = true )
+    alx( "remove " + rest, success )
+  end
+
+  def list( rest = "", success = true )
+    alx( "list " + rest, success )
+  end
+
+  def show( rest = "", success = true )
+    alx( "show -o " + rest, success )
+  end
+
+  def export( rest = [], success = true )
+    alx( "export " + rest.join( "," ), success )
+  end
+
+  def alx( rest, success_expected )
+    pipe = IO.popen( "bin/alx #{rest}" )
+    Process.wait
+    @output = pipe.readlines.join( "" )
+    was_success.should == success_expected
+  end
+
+  def was_success
+    $?.exitstatus == 0
+  end
+
+  def check_file_presence( path, expected )
+    File.exists?( path ).should == expected
+  end
+
+  def check_directory_presence( path, expected )
+    File.directory?( path ).should == expected
+  end
+
+  def alx_commands
+    Alx::Controller.new( {} ).handlers.keys
+  end
+
+  def conf_dir
+    "/tmp/fake_home/#{Alx::CONF_BASE_DIR}"
+  end
+
+  def conf_file
+    conf_dir + "/#{Alx::CONF_FILE}"
+  end
+
+  def lib_dir
+    conf_dir + "/#{Alx::LIB_BASE_DIR}/#{Alx::DEFAULT_SHELF}"
+  end
+
+  def cleanup_home
+    FileUtils.rm_rf( conf_dir, :secure => true )
+  end
+end
+
+World( AlxHelpers )
+

data/features/support/env.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+
+LIB_DIR = File.join( File.expand_path( File.dirname( __FILE__ ) ), '..', '..', 'lib' )
+
+Before do
+  @real_home = ENV['HOME']
+  fake_home = File.join( '/tmp/', 'fake_home' )
+  FileUtils.rm_rf( fake_home, :secure => true )
+  FileUtils.mkdir( fake_home )
+  ENV['HOME'] = fake_home
+
+  @original_editor = ENV['EDITOR']
+
+  spec = Gem::Specification.find_by_name( 'redcarpet' )
+  gem_root = spec.gem_dir
+  gem_lib = gem_root + "/" + spec.require_paths[0]
+
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s + File::PATH_SEPARATOR + gem_lib
+end
+
+After do
+  ENV['HOME'] = @real_home
+  ENV['RUBYLIB'] = @original_rubylib
+  ENV['EDITOR'] = @original_editor;
+end
+

data/lib/alx/add_handler.rb

@@ -0,0 +1,25 @@
+require 'alx/handler'
+require 'alx/editor'
+
+module Alx
+
+  class AddHandler < Handler
+    def initialize( configuration )
+      super(
+        :configuration => configuration,
+        :command => 'add',
+        :rest_description => 'book title',
+        :description => "Adds new book to the library.",
+        :options => [ :editor, :stdin ] )
+    end
+
+    def handle
+      parse_options
+      options_error( "No file name given. Please provide one." ) if @conf[ :rest ].empty?
+      book_file_name = @conf[ :default_shelf_dir ] + "/" +@conf[ :rest ].gsub( / /, "_" )
+      Editor.new( @conf ).edit( book_file_name )
+    end
+  end
+
+end
+

data/lib/alx/book.rb

@@ -0,0 +1,20 @@
+module Alx
+
+  class Book
+    attr_reader :title, :file_name
+    def initialize( title, file_name )
+      @title = title
+      @file_name = file_name
+    end
+
+    def content
+      content = ""
+      File.open( @file_name ) do | file |
+        file.each { | line | content+=line }
+      end
+      return content
+    end
+  end
+
+end
+

data/lib/alx/configuration.rb

@@ -0,0 +1,51 @@
+require 'fileutils'
+require 'yaml'
+
+module Alx
+
+  CONF_BASE_DIR=".alx"
+  CONF_FILE="conf"
+  LIB_BASE_DIR="library"
+  DEFAULT_SHELF="home"
+
+  DEFAULT_CONFIG = {
+    :editor => 'vim',
+    :html_viewer => 'elinks',
+    :terminal_viewer => 'less -R',
+  }
+
+  class Configuration
+
+    def initialize
+      @conf = {}
+      @conf[ :alx_home ] = ENV[ 'HOME' ] + "/#{CONF_BASE_DIR}"
+      @conf[ :conf_file ] = @conf[ :alx_home ] + "/#{CONF_FILE}"
+      @conf[ :default_shelf_dir ] = @conf[ :alx_home ] + "/#{LIB_BASE_DIR}/#{DEFAULT_SHELF}"
+
+      FileUtils::mkdir_p( @conf[ :default_shelf_dir ] )
+      create_default_config_if_needed( @conf[ :conf_file ] )
+      from_conf_file = load_config( @conf[ :conf_file ] )
+      @conf.merge!( from_conf_file )
+
+      @conf[ :editor ] = ENV[ 'EDITOR' ] if ENV[ 'EDITOR' ]
+      @conf[ :command ] = ARGV[ 0 ]
+      @conf[ :rest ] = ARGV[ 1..-1 ]
+    end
+
+    def hash
+      @conf
+    end
+
+    protected
+    def create_default_config_if_needed( file_name )
+      return if File.exist?( file_name )
+      File.open( file_name, "w" ) { | file | YAML.dump( DEFAULT_CONFIG, file ) }
+    end
+
+    def load_config( file_name )
+      YAML.load_file( file_name )
+    end
+  end
+
+end
+

data/lib/alx/controller.rb

@@ -0,0 +1,43 @@
+require 'alx/add_handler'
+require 'alx/list_handler'
+require 'alx/show_handler'
+require 'alx/help_handler'
+require 'alx/remove_handler'
+
+module Alx
+
+  class Controller
+    attr_reader :handlers
+
+    def initialize( configuration )
+      @conf = configuration
+      @handlers = {}
+      register_handlers
+    end
+
+    def run
+      command = @conf[ :command ]
+      if @handlers[ command ]
+        @handlers[ command ].handle
+      else
+        @handlers[ 'help' ].handle
+        raise "I don't understand command: #{command}"
+      end
+    end
+
+    private
+    def register_handlers
+      add_handler( AddHandler.new( @conf ) )
+      add_handler( ListHandler.new( @conf ) )
+      add_handler( ShowHandler.new( @conf ) )
+      add_handler( RemoveHandler.new( @conf ) )
+      add_handler( HelpHandler.new( @conf, self ) )
+    end
+
+    def add_handler( handler )
+      @handlers[ handler.command_name ] = handler
+    end
+  end
+
+end
+

data/lib/alx/editor.rb

@@ -0,0 +1,33 @@
+require 'alx/executer'
+
+module Alx
+
+  class Editor
+    include Executer
+
+    def initialize( conf )
+      @conf = conf
+    end
+
+    def edit( file_name )
+      @editor_command = @conf[ :editor ]
+      @editor_command ? use_editor( file_name ) : use_stdin( file_name )
+    end
+
+    private
+    def use_editor( file_name )
+      start( "#{@editor_command} #{file_name}")
+    end
+
+    def use_stdin( file_name )
+      puts( 'Reading input from standard input.' )
+      File.open( file_name, "a" ) do | file |
+        while line = $stdin.gets
+          file.puts( line )
+        end
+      end
+    end
+  end
+
+end
+