ruby-notes 1.0.0

data/bin/notes.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'notes'
+module Notes
+  parser = Options::OptionParser.new ARGV
+  crud_controller = CRUDController.new 'notes'
+  crud_controller.perform_action parser.parse
+end

data/lib/notes.rb

@@ -0,0 +1,35 @@
+require 'trollop'
+require 'mongo'
+require 'set'
+
+require 'notes/export/base_export'
+require 'notes/export/console_export'
+require 'notes/export/html_export'
+require 'notes/export/csv_export'
+
+require 'notes/model/note'
+require 'notes/model/criteria'
+
+require 'notes/controller/option_parser'
+require 'notes/controller/crud_controller'
+require 'notes/controller/db_controller'
+
+require 'notes/utils/array_util'
+
+require 'notes/options/base_option'
+require 'notes/options/add_note'
+require 'notes/options/description'
+require 'notes/options/due_date'
+require 'notes/options/find_note'
+require 'notes/options/token'
+require 'notes/options/remove_note'
+require 'notes/options/tag'
+require 'notes/options/update_note'
+require 'notes/options/html'
+require 'notes/options/csv'
+require 'notes/options/console'
+require 'notes/options/options'
+require 'notes/options/current'
+require 'notes/options/option_consts'
+require 'notes/options/all'
+

data/lib/notes/controller/crud_controller.rb

@@ -0,0 +1,63 @@
+module Notes
+  class CRUDController
+    def initialize collection_name
+      @db_controller = DatabaseController.new collection_name
+    end
+
+    def perform_action options
+      init options
+      if @options[Options::ADD_NOTE]
+        create
+      elsif @options[Options::REMOVE_NOTE]
+        remove
+      elsif @options[Options::UPDATE_NOTE]
+        update
+      elsif @options[Options::FIND_NOTE]
+        find
+      end
+    end
+
+    private
+    def init options
+      @options = options
+      @criterias = get_criterias
+      if options[Options::CONSOLE_EXPORT]
+        @export = ConsoleExport.new
+      elsif options[Options::HTML_EXPORT]
+        @export = HtmlExport.new options[Options::HTML_EXPORT]
+      elsif options[Options::CSV_EXPORT]
+        @export = CsvExport.new options[Options::CSV_EXPORT]
+      end
+    end
+
+    def create
+      @db_controller.create Note.new @options
+    end
+
+    def remove
+      @db_controller.remove @criterias
+    end
+
+    def update
+      @db_controller.update Note.new(@options), @criterias
+    end
+
+    def find
+      result_collection = @db_controller.find @criterias
+      if result_collection
+        puts @export.export_notes result_collection
+      end
+    end
+
+    def get_criterias
+      result = []
+      criterias = [Options::TAG, Options::DESCRIPTION, Options::CURRENT, Options::DUE_DATE, Options::TOKEN , Options::ALL]
+      @options.each do |key, value|
+        if criterias.include?(key) && @options[key] && @options[key] != []
+          result << Criteria.new(key.to_s, value)
+        end
+      end
+      result
+    end
+  end
+end

data/lib/notes/controller/db_controller.rb

@@ -0,0 +1,63 @@
+module Notes
+    class DatabaseController
+      def initialize collection_name
+        @collection = Mongo::Connection.new('localhost').db('notes')[collection_name]
+      end
+
+      def find criterias
+        if should_apply_to_all?(criterias)
+          return get_all_records
+        end
+        @collection.find({'$and' => get_criterias_as_hashes(criterias)})
+      end
+
+      def find_one criterias
+        @collection.find_one({'$and' => get_criterias_as_hashes(criterias)})
+      end
+
+      def get_all_records
+        @collection.find
+      end
+
+      def create note
+        @collection.insert(note.to_hash)
+      end
+
+      def remove criterias
+        if should_apply_to_all?(criterias)
+          remove_all
+          return 
+        end
+        @collection.remove({'$and' =>  get_criterias_as_hashes(criterias)})
+      end
+
+      def remove_all
+        @collection.remove({})
+      end
+
+      def update note, criterias
+        criterias.each do |criteria|
+          @collection.update({'token' => note.token}, {'$set' => {criteria.name => criteria.value}})
+        end
+      end
+
+      private
+      def should_apply_to_all?(criterias)
+        criteria_hashes = get_criterias_as_hashes criterias
+        criteria_hashes.each do |criteria|
+          if criteria[Notes::Options::ALL.to_s]
+            return true
+          end
+        end
+        false
+      end
+
+      def get_criterias_as_hashes criterias
+        result = []
+        criterias.each do |criteria|
+          result << criteria.to_hash
+        end
+        result
+      end
+    end
+end

data/lib/notes/controller/option_parser.rb

@@ -0,0 +1,18 @@
+module Notes
+  module Options
+    class OptionParser
+      def initialize(args)
+        @parsed_options = {}
+      end
+
+      def parse
+        @parsed_options = Trollop::options do
+            Options.get_options.each do |option|
+              opt option.name, option.description, option.options
+            end
+        end
+        @parsed_options
+      end
+    end
+  end
+end

data/lib/notes/export/base_export.rb

@@ -0,0 +1,17 @@
+module Notes
+  class BaseExport
+
+    TOKEN = 'TOKEN'
+    TAG = 'TAG'
+    DESCRIPTION = 'DESCRIPTION'
+    DUE_DATE = 'DUE DATE'
+
+    private
+    def get_tags_string tags
+      if tags.kind_of? Array
+        return Notes::ArrayUtil.array_to_string tags
+      end
+      tags
+    end
+  end
+end

data/lib/notes/export/console_export.rb

@@ -0,0 +1,38 @@
+module Notes
+  class ConsoleExport < BaseExport
+    TOKEN_FIELD_LENGTH =  20
+    TAG_FIELD_LENGTH = 25
+    DESCRIPTION_FIELD_LENGTH = 50
+    DUE_DATE_FIELD_LENGTH = 14
+    HEADER = '+' + '-' * (TOKEN_FIELD_LENGTH + TAG_FIELD_LENGTH + DESCRIPTION_FIELD_LENGTH + DUE_DATE_FIELD_LENGTH + 3) + '+'
+
+    def export_notes note_list
+      result = HEADER + "\n"
+      heading = center_in_container(TOKEN_FIELD_LENGTH, TOKEN) + center_in_container(TAG_FIELD_LENGTH, TAG)
+      heading += center_in_container(DESCRIPTION_FIELD_LENGTH, DESCRIPTION) + center_in_container(DUE_DATE_FIELD_LENGTH, DUE_DATE)
+      result +=  heading + '|' + "\n"
+      result +=  HEADER + "\n"
+      note_list.each do |note|
+        result += export_note note
+        result += "\n"
+      end
+      result += HEADER + "\n"
+      result
+    end
+
+    def export_note(note_hash)
+      result = center_in_container(TOKEN_FIELD_LENGTH, note_hash[Options::TOKEN.to_s])
+      result += center_in_container(TAG_FIELD_LENGTH, get_tags_string(note_hash[Options::TAG.to_s]))
+      result += center_in_container(DESCRIPTION_FIELD_LENGTH, note_hash[Options::DESCRIPTION.to_s])
+      result += center_in_container(DUE_DATE_FIELD_LENGTH, note_hash[Options::DUE_DATE.to_s])
+      result += '|'
+      result
+    end
+    
+    private
+    def center_in_container(container_length, content)
+      '|' + ' ' * ((container_length - content.length)/2.0).floor + content + ' ' * ((container_length - content.length)/2.0).ceil
+    end
+
+  end
+end

data/lib/notes/export/csv_export.rb

@@ -0,0 +1,27 @@
+module Notes
+  class CsvExport < BaseExport
+    CSV_VALUE_SEPARATOR = ', '
+
+    def initialize output_file_path
+      @file = File.new output_file_path, 'w+'
+    end
+
+    def export_notes notes_list
+      res = TOKEN + CSV_VALUE_SEPARATOR + TAG + CSV_VALUE_SEPARATOR + DESCRIPTION + CSV_VALUE_SEPARATOR + DUE_DATE + "\n"
+      notes_list.each do |note|
+        res += export_note note
+        res += "\n"
+      end
+      res.chomp! "\n"
+      @file.puts res
+      @file.close
+    end
+
+    def export_note note_hash
+      res = note_hash[Options::TOKEN.to_s]  + CSV_VALUE_SEPARATOR + get_tags_string(note_hash[Options::TAG.to_s])
+      res +=  CSV_VALUE_SEPARATOR + '"' + note_hash[Options::DESCRIPTION.to_s] + '"'
+      res += CSV_VALUE_SEPARATOR + note_hash[Options::DUE_DATE.to_s]
+      res
+    end
+  end
+end

data/lib/notes/export/html_export.rb

@@ -0,0 +1,51 @@
+module Notes
+  class HtmlExport  < BaseExport
+    DOCTYPE = '<!DOCTYPE html>'
+    HTML = '<html>'
+    HEAD = '<head>'
+    BODY = '<body>'
+    ENCODING = '<meta http-equiv="content-type" content="text/html; charset=utf-8" />'
+    TITLE = '<title>Notes</title>'
+    TABLE = '<table style="text-align: center;">'
+    TABLE_ROW = '<tr>'
+    TABLE_CELL = '<td>'
+
+    def initialize output_file_path
+      @file = File.new output_file_path , 'w+'
+    end
+
+    def export_notes notes_list
+      res = TABLE + TABLE_ROW  + TABLE_CELL + TOKEN + get_closing_tag(TABLE_CELL) + TABLE_CELL + TAG + get_closing_tag(TABLE_CELL)
+      res += TABLE_CELL + DESCRIPTION + get_closing_tag(TABLE_CELL) + TABLE_CELL + DUE_DATE + get_closing_tag(TABLE_CELL)
+      res += get_closing_tag(TABLE_ROW)
+      notes_list.each do |note|
+        res += export_note note
+      end
+      res += get_closing_tag TABLE
+      @file.puts(attach_headers res)
+      @file.close
+    end
+
+    def export_note note_hash
+      res = TABLE_ROW
+      res += TABLE_CELL + note_hash[Notes::Options::TOKEN.to_s] + get_closing_tag(TABLE_CELL)
+      res += TABLE_CELL + get_tags_string(note_hash[Notes::Options::TAG.to_s]) + get_closing_tag(TABLE_CELL)
+      res += TABLE_CELL + note_hash[Notes::Options::DESCRIPTION.to_s] + get_closing_tag(TABLE_CELL)
+      res += TABLE_CELL + note_hash[Notes::Options::DUE_DATE.to_s] + get_closing_tag(TABLE_CELL)
+      res += get_closing_tag(TABLE_ROW)
+      res
+    end
+
+    private
+    def attach_headers html_body
+      res = DOCTYPE  + HTML + HEAD + ENCODING
+      res += TITLE + get_closing_tag(HEAD) 
+      res += BODY + html_body + get_closing_tag(BODY) + get_closing_tag(HTML)
+      res
+    end
+
+    def get_closing_tag opening_tag
+      opening_tag.sub("<","</")
+    end
+  end
+end

data/lib/notes/model/criteria.rb

@@ -0,0 +1,16 @@
+module Notes
+    class Criteria
+      attr_reader :name, :value
+      def initialize(name, value)
+        @name = name
+        @value = value
+      end
+
+      def to_hash
+        if @value.kind_of? Array
+          return {@name => (Notes::ArrayUtil.array_to_string @value)}
+        end
+        {@name => @value}
+      end
+    end
+end

data/lib/notes/model/note.rb

@@ -0,0 +1,25 @@
+module Notes
+  class Note
+    attr_reader :tag, :description, :due_date, :token
+
+    def initialize options
+      @tag = (options[Options::TAG] && options[Options::TAG] != [])? options[Options::TAG] : 'unspecified'
+      @description = options[Options::DESCRIPTION] ? options[Options::DESCRIPTION] : 'unspecified'
+      @due_date = options[Options::DUE_DATE] ? options[Options::DUE_DATE] : 'unspecified'
+      @token = options[Options::TOKEN] ? options[Options::TOKEN] : 'unspecified'
+    end
+
+    def to_hash
+      result_hash = {}
+      result_hash[Options::TAG.to_s] = @tag
+      result_hash[Options::DESCRIPTION.to_s] = @description
+      result_hash[Options::DUE_DATE.to_s] =  @due_date
+      result_hash[Options::TOKEN.to_s] = get_token.to_s
+      result_hash
+    end
+
+    def get_token
+      @tag.hash * 1231 + @description.hash * 1237 + @due_date.hash * 37
+    end
+  end
+end

data/lib/notes/options/add_note.rb

@@ -0,0 +1,13 @@
+module Notes
+  module Options
+    class AddNote < BaseOption
+      def name
+        Notes::Options::ADD_NOTE
+      end
+
+      def description
+        'Add a new note with the parameters specified'
+      end
+    end
+  end
+end

data/lib/notes/options/all.rb

@@ -0,0 +1,14 @@
+module Notes
+  module Options
+    class All < BaseOption
+      def name
+        Notes::Options::ALL
+      end
+
+      def description
+        'Specified action is applied to all the matching notes'
+      end
+    end
+  end
+end
+

data/lib/notes/options/base_option.rb

@@ -0,0 +1,17 @@
+module Notes
+  module Options
+    class BaseOption
+      def name
+        raise 'Unsupported operation'
+      end
+
+      def description
+        raise 'Unsupported operation'
+      end
+
+      def options
+        {:type => nil, :multi => false}
+      end
+    end
+  end
+end

data/lib/notes/options/console.rb

@@ -0,0 +1,13 @@
+module Notes
+  module Options
+    class Console < BaseOption
+      def name
+        Notes::Options::CONSOLE_EXPORT
+      end
+
+      def description
+        'The result of this operation(if any) will be printed in the console'
+      end
+    end
+  end
+end

data/lib/notes/options/csv.rb

@@ -0,0 +1,18 @@
+module Notes
+  module Options
+    class CSV < BaseOption
+      def name
+        Notes::Options::CSV_EXPORT
+      end
+
+      def options
+        { :type => String, :multi => false}
+      end
+
+      def description
+        'The result of this operation(if any) will be printed in the file specified in csv format.'
+      end
+    end
+  end
+end
+

data/lib/notes/options/current.rb

@@ -0,0 +1,13 @@
+module Notes
+  module Options
+    class Current < BaseOption
+      def name
+        Notes::Options::CURRENT
+      end
+
+      def description
+        'Specified action will only be applied to notes with due date that is after or coincides with the current day.'
+      end
+    end
+  end
+end

data/lib/notes/options/description.rb

@@ -0,0 +1,17 @@
+module Notes
+  module Options
+    class Description < BaseOption
+      def name
+        Notes::Options::DESCRIPTION
+      end
+
+      def description
+        'Specify the description for the note'
+      end
+      
+      def options
+        {:type => String, :multi => false }
+      end
+    end
+  end
+end

data/lib/notes/options/due_date.rb

@@ -0,0 +1,17 @@
+module Notes
+  module Options
+    class DueDate < BaseOption
+      def name
+        Notes::Options::DUE_DATE
+      end
+      
+      def description
+        'Specify the due date for the note'
+      end
+
+      def options
+        {:type => String, :multi => false }
+      end
+    end
+  end
+end

data/lib/notes/options/find_note.rb

@@ -0,0 +1,13 @@
+module Notes
+  module Options
+    class FindNote < BaseOption
+      def name
+        Notes::Options::FIND_NOTE
+      end
+
+      def description
+        'Finds the note specified.'
+      end
+    end
+  end
+end

data/lib/notes/options/html.rb

@@ -0,0 +1,17 @@
+module Notes
+  module Options
+    class Html < BaseOption
+      def name
+        Notes::Options::HTML_EXPORT
+      end
+
+      def options
+        { :type => String, :multi => false }
+      end
+
+      def description
+        'The result of this operation(if any) will be saved into the file given in html format'
+      end
+    end
+  end
+end

data/lib/notes/options/option_consts.rb

@@ -0,0 +1,17 @@
+module Notes
+  module Options
+    ADD_NOTE = :add_note
+    REMOVE_NOTE = :remove_note
+    UPDATE_NOTE = :update_note
+    FIND_NOTE = :find_note
+    TAG = :tag
+    DESCRIPTION = :description
+    DUE_DATE = :due_date
+    TOKEN = :token
+    CONSOLE_EXPORT = :console
+    CSV_EXPORT = :csv
+    HTML_EXPORT = :html
+    CURRENT = :current
+    ALL = :all
+  end
+end

data/lib/notes/options/options.rb

@@ -0,0 +1,12 @@
+module Notes
+  module Options
+    class Options
+      def self.get_options
+        options = [AddNote.new, RemoveNote.new, FindNote.new, UpdateNote.new]
+        options += [Tag.new, Description.new, DueDate.new, Token.new, Html.new]
+        options += [CSV.new, Console.new, Current.new, All.new]
+        options
+      end
+    end
+  end
+end

data/lib/notes/options/remove_note.rb

@@ -0,0 +1,13 @@
+module Notes
+  module Options
+    class RemoveNote < BaseOption
+      def name
+        Notes::Options::REMOVE_NOTE
+      end
+
+      def description
+        'Removes the specified note'
+      end
+    end
+  end
+end

data/lib/notes/options/tag.rb

@@ -0,0 +1,17 @@
+module Notes
+  module Options
+    class Tag < BaseOption
+      def name
+        Notes::Options::TAG
+      end
+
+      def description
+        'Specified action only takes effect on notes with the tag given.'
+      end
+
+      def options
+        {:type => String, :multi => true}
+      end
+    end
+  end
+end

data/lib/notes/options/token.rb

@@ -0,0 +1,17 @@
+module Notes
+  module Options
+    class Token < BaseOption
+      def name
+        Notes::Options::TOKEN
+      end
+      
+      def description
+        'Specified action is only applied to the note with the id given.'
+      end
+
+      def options
+        { :type => String, :multi => false}
+      end
+    end
+  end
+end

data/lib/notes/options/update_note.rb

@@ -0,0 +1,13 @@
+module Notes
+  module Options
+    class UpdateNote < BaseOption
+      def name
+        Notes::Options::UPDATE_NOTE
+      end
+
+      def description
+        'Update the note given'
+      end
+    end
+  end
+end

data/spec/criteria_spec.rb

@@ -0,0 +1,16 @@
+describe Notes::Criteria do
+  describe 'initialization' do
+    it 'correctly initializes fields' do
+      criteria = Notes::Criteria.new 'name', 'value'
+      criteria.name.should eq 'name'
+      criteria.value.should eq 'value'
+    end
+  end
+
+  describe 'to_hash' do
+    it 'correctly creates corresponding hash' do
+      criteria = Notes::Criteria.new 'name', 'value'
+      criteria.to_hash.should eq ({'name' => 'value'})
+    end
+  end
+end

data/spec/crud_spec.rb

@@ -0,0 +1,32 @@
+describe Notes::CRUDController do
+  describe 'it correctly performs action' do
+    
+    before do
+      @crud_controller = Notes::CRUDController.new 'test'
+      @db_controller = Notes::DatabaseController.new 'test'
+    end
+
+    after do
+      @crud_controller.perform_action({Notes::Options::REMOVE_NOTE => true, Notes::Options::ALL => true})
+    end
+
+    it 'creates new note' do
+      @crud_controller.perform_action({Notes::Options::ADD_NOTE => true})
+      result_count = 0
+      @db_controller.get_all_records.each do |record|
+        result_count += 1
+      end
+      result_count.should eq 1
+    end
+
+    it 'removes note' do
+      @crud_controller.perform_action({Notes::Options::ADD_NOTE => true, Notes::Options::TAG => 'to do'})
+      @crud_controller.perform_action({Notes::Options::REMOVE_NOTE => true, Notes::Options::TAG => 'to do'})
+      result_count = 0
+      @db_controller.get_all_records.each do |record|
+        result_count += 1
+      end
+      result_count.should eq 0
+    end
+  end
+end

data/spec/db_spec.rb

@@ -0,0 +1,51 @@
+describe 'works with db' do
+
+  before do
+    @db_controller = Notes::DatabaseController.new 'spec'
+    test_hash = {}
+    test_hash[Notes::Options::TAG] = 'to do'
+    test_hash[Notes::Options::DESCRIPTION] = 'description'
+    test_hash[Notes::Options::DUE_DATE] = '16.02.2012'
+    @note = Notes::Note.new(test_hash)
+    @db_controller.create @note
+  end
+
+  after do
+    @db_controller.remove_all
+  end
+
+  it 'can insert and find notes notes successfully' do
+    search_criteria = [Notes::Criteria.new(Notes::Options::TAG.to_s, 'to do')]
+    search_criteria << Notes::Criteria.new(Notes::Options::DESCRIPTION.to_s, 'description')
+    search_criteria << Notes::Criteria.new(Notes::Options::DUE_DATE.to_s, '16.02.2012')
+    query_result = @db_controller.find search_criteria
+    result_length = 0
+    query_result.each do |result|
+      result_length += 1
+    end
+    result_length.should eq 1
+  end
+
+  it 'can update note' do
+    inserted_note = @db_controller.find_one([Notes::Criteria.new(Notes::Options::TAG.to_s, 'to do')])
+    update_criteria = [Notes::Criteria.new(Notes::Options::TAG.to_s, 'other')]
+    @db_controller.update(Notes::Note.new({Notes::Options::TOKEN => inserted_note[Notes::Options::TOKEN.to_s]}), update_criteria)
+    query_result = @db_controller.find update_criteria
+    result_length = 0
+    query_result.each do |result|
+      result_length +=1
+    end
+    result_length.should eq 1
+  end
+
+  it 'can remove note' do
+    criterias = [Notes::Criteria.new(Notes::Options::TAG.to_s, 'to do')]
+    @db_controller.remove criterias
+    query_result = @db_controller.find criterias
+    result_length = 0
+    query_result.each do |result|
+      result_length +=1
+    end
+    result_length.should eq 0
+  end
+end

data/spec/export_spec.rb

@@ -0,0 +1,84 @@
+describe 'export' do
+  
+  before do
+    @test_hash = {}
+    @test_hash[Notes::Options::TOKEN.to_s] = '1963438776275'
+    @test_hash[Notes::Options::TAG.to_s] = 'unspecified'
+    @test_hash[Notes::Options::DESCRIPTION.to_s] = 'asd'
+    @test_hash[Notes::Options::DUE_DATE.to_s] = 'unspecified'
+  end
+
+  describe 'console export' do
+    it 'renders properly single line output'do
+      console_export = Notes::ConsoleExport.new
+      console_export.export_notes([@test_hash]).should eq <<EXPORT
++----------------------------------------------------------------------------------------------------------------+
+|       TOKEN        |           TAG           |                   DESCRIPTION                    |   DUE DATE   |
++----------------------------------------------------------------------------------------------------------------+
+|   1963438776275    |       unspecified       |                       asd                        | unspecified  |
++----------------------------------------------------------------------------------------------------------------+
+EXPORT
+    end
+
+    it 'renders properly complex output' do
+      console_export = Notes::ConsoleExport.new
+      console_export.export_notes([@test_hash,@test_hash,@test_hash]).should eq <<EXPORT
++----------------------------------------------------------------------------------------------------------------+
+|       TOKEN        |           TAG           |                   DESCRIPTION                    |   DUE DATE   |
++----------------------------------------------------------------------------------------------------------------+
+|   1963438776275    |       unspecified       |                       asd                        | unspecified  |
+|   1963438776275    |       unspecified       |                       asd                        | unspecified  |
+|   1963438776275    |       unspecified       |                       asd                        | unspecified  |
++----------------------------------------------------------------------------------------------------------------+
+EXPORT
+    end
+  end
+
+  describe 'html export' do
+    after do
+      File.delete "./out.html"
+    end
+    it 'renders properly single line output' do
+      html_export = Notes::HtmlExport.new './out.html'
+      html_export.export_notes [@test_hash]
+      IO.read("./out.html").should eq <<EXPORT
+<!DOCTYPE html><html><head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><title>Notes</title></head><body><table style="text-align: center;"><tr><td>TOKEN</td><td>TAG</td><td>DESCRIPTION</td><td>DUE DATE</td></tr><tr><td>1963438776275</td><td>unspecified</td><td>asd</td><td>unspecified</td></tr></table style="text-align: center;"></body></html>
+EXPORT
+    end
+
+    it 'renders complex output correctly' do
+      html_export = Notes::HtmlExport.new './out.html'
+      html_export.export_notes [@test_hash,@test_hash,@test_hash]
+      IO.read("./out.html").should eq <<EXPORT
+<!DOCTYPE html><html><head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><title>Notes</title></head><body><table style="text-align: center;"><tr><td>TOKEN</td><td>TAG</td><td>DESCRIPTION</td><td>DUE DATE</td></tr><tr><td>1963438776275</td><td>unspecified</td><td>asd</td><td>unspecified</td></tr><tr><td>1963438776275</td><td>unspecified</td><td>asd</td><td>unspecified</td></tr><tr><td>1963438776275</td><td>unspecified</td><td>asd</td><td>unspecified</td></tr></table style="text-align: center;"></body></html>
+EXPORT
+    end
+  end
+
+  describe 'csv export' do
+    
+    after do
+      File.delete './out.csv'
+    end
+
+    it 'renders properly single line output' do
+      csv_export = Notes::CsvExport.new './out.csv'
+      csv_export.export_notes [@test_hash]
+      IO.read("./out.csv").should eq <<EXPORT
+TOKEN, TAG, DESCRIPTION, DUE DATE
+1963438776275, unspecified, "asd", unspecified
+EXPORT
+    end
+
+    it 'renders complex output correctly' do
+      csv_export = Notes::CsvExport.new './out.csv'
+      csv_export.export_notes [@test_hash, @test_hash, @test_hash]
+      IO.read("./out.csv").should eq <<EXPORT
+TOKEN, TAG, DESCRIPTION, DUE DATE
+1963438776275, unspecified, "asd", unspecified
+1963438776275, unspecified, "asd", unspecified
+1963438776275, unspecified, "asd", unspecified
+EXPORT
+    end
+  end
+end

data/spec/note_spec.rb

@@ -0,0 +1,52 @@
+describe Notes::Note do
+  before do
+    @test_hash = {}
+  end
+
+  describe 'initialization' do
+    it 'can be initialized with default args' do
+      note = Notes::Note.new(@test_hash)
+    end
+
+    it 'gets default values if none were specified ' do
+      note = Notes::Note.new(@test_hash)
+      note.tag.should eq 'unspecified'
+      note.description.should eq 'unspecified'
+      note.due_date.should eq 'unspecified'
+    end
+
+    it 'correctly reads passed values' do
+      @test_hash[Notes::Options::TAG] = ['to do']
+      @test_hash[Notes::Options::DESCRIPTION] = 'description'
+      @test_hash[Notes::Options::DUE_DATE] = '18.02.2012'
+      note = Notes::Note.new @test_hash
+      note.tag.should eq ['to do']
+      note.description.should eq 'description'
+      note.due_date.should eq '18.02.2012'
+    end
+  end
+
+  describe 'to_hash' do
+    it 'correctly creates corresponding hash when no parameters are specified' do
+      note = Notes::Note.new(@test_hash)
+      @test_hash[Notes::Options::TAG.to_s] = 'unspecified'
+      @test_hash[Notes::Options::DESCRIPTION.to_s] = 'unspecified'
+      @test_hash[Notes::Options::DUE_DATE.to_s] = 'unspecified'
+      @test_hash[Notes::Options::TOKEN.to_s] = note.get_token.to_s
+      note.to_hash.should eq @test_hash
+    end
+
+    it 'correctly creates corresponding has when parameters are given' do
+      @test_hash[Notes::Options::TAG] = ['to do']
+      @test_hash[Notes::Options::DESCRIPTION] = 'description'
+      @test_hash[Notes::Options::DUE_DATE] = '18.02.2012'
+      note = Notes::Note.new @test_hash
+      test_against_hash = {}
+      test_against_hash[Notes::Options::TAG.to_s] = ['to do']
+      test_against_hash[Notes::Options::DESCRIPTION.to_s] = 'description'
+      test_against_hash[Notes::Options::DUE_DATE.to_s] = '18.02.2012'
+      test_against_hash[Notes::Options::TOKEN.to_s] = note.get_token.to_s
+      note.to_hash.should eq test_against_hash
+    end
+  end
+end

data/spec/options_spec.rb

@@ -0,0 +1,86 @@
+describe 'Options' do
+  describe 'initialization' do
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::AddNote.new
+      add_note.name.should eq Notes::Options::ADD_NOTE
+      add_note.description.should eq 'Add a new note with the parameters specified'
+      add_note.options.should eq ({:type => nil, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::Console.new
+      add_note.name.should eq Notes::Options::CONSOLE_EXPORT
+      add_note.description.should eq 'The result of this operation(if any) will be printed in the console'
+      add_note.options.should eq ({:type => nil, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::CSV.new
+      add_note.name.should eq Notes::Options::CSV_EXPORT
+      add_note.description.should eq 'The result of this operation(if any) will be printed in the file specified in csv format.'
+      add_note.options.should eq ({:type => String, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::Current.new
+      add_note.name.should eq Notes::Options::CURRENT
+      add_note.description.should eq 'Specified action will only be applied to notes with due date that is after or coincides with the current day.'
+      add_note.options.should eq ({:type => nil, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::Description.new
+      add_note.name.should eq Notes::Options::DESCRIPTION
+      add_note.description.should eq 'Specify the description for the note'
+      add_note.options.should eq ({:type => String, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::DueDate.new
+      add_note.name.should eq Notes::Options::DUE_DATE
+      add_note.description.should eq 'Specify the due date for the note'
+      add_note.options.should eq ({:type => String, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::FindNote.new
+      add_note.name.should eq Notes::Options::FIND_NOTE
+      add_note.description.should eq 'Finds the note specified.'
+      add_note.options.should eq ({:type => nil, :multi => false})
+    end
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::Html.new
+      add_note.name.should eq Notes::Options::HTML_EXPORT
+      add_note.description.should eq 'The result of this operation(if any) will be saved into the file given in html format'
+      add_note.options.should eq ({:type => String, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::Token.new
+      add_note.name.should eq Notes::Options::TOKEN
+      add_note.description.should eq 'Specified action is only applied to the note with the id given.'
+      add_note.options.should eq ({:type => String, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::RemoveNote.new
+      add_note.name.should eq Notes::Options::REMOVE_NOTE
+      add_note.description.should eq 'Removes the specified note'
+      add_note.options.should eq ({:type => nil, :multi => false})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::Tag.new
+      add_note.name.should eq Notes::Options::TAG
+      add_note.description.should eq 'Specified action only takes effect on notes with the tag given.'
+      add_note.options.should eq ({:type => String, :multi => true})
+    end
+
+    it 'returns name, description and type correctly' do
+      add_note = Notes::Options::UpdateNote.new
+      add_note.name.should eq Notes::Options::UPDATE_NOTE
+      add_note.description.should eq 'Update the note given'
+      add_note.options.should eq ({:type => nil, :multi => false})
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-notes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Martin Asenov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-17 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Ruby notes is a console lne tool that let you keep reminders/notes and afterwards search within them and export the result to various formats.
+email: asenov.m@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/notes.rb
+- lib/notes.rb
+- lib/notes/controller/crud_controller.rb
+- lib/notes/controller/db_controller.rb
+- lib/notes/controller/option_parser.rb
+- lib/notes/export/base_export.rb
+- lib/notes/export/console_export.rb
+- lib/notes/export/csv_export.rb
+- lib/notes/export/html_export.rb
+- lib/notes/model/note.rb
+- lib/notes/model/criteria.rb
+- lib/notes/options/add_note.rb
+- lib/notes/options/all.rb
+- lib/notes/options/base_option.rb
+- lib/notes/options/console.rb
+- lib/notes/options/csv.rb
+- lib/notes/options/current.rb
+- lib/notes/options/description.rb
+- lib/notes/options/due_date.rb
+- lib/notes/options/find_note.rb
+- lib/notes/options/html.rb
+- lib/notes/options/option_consts.rb
+- lib/notes/options/options.rb
+- lib/notes/options/remove_note.rb
+- lib/notes/options/tag.rb
+- lib/notes/options/token.rb
+- lib/notes/options/update_note.rb
+- spec/criteria_spec.rb
+- spec/crud_spec.rb
+- spec/db_spec.rb
+- spec/export_spec.rb
+- spec/note_spec.rb
+- spec/options_spec.rb
+has_rdoc: true
+homepage: https://github.com/asenovm/Ruby-Notes
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: console line tool that let you easily keep reminders/notes.
+test_files: 
+- spec/criteria_spec.rb
+- spec/crud_spec.rb
+- spec/db_spec.rb
+- spec/export_spec.rb
+- spec/note_spec.rb
+- spec/options_spec.rb