sculd 0.0.1 → 0.0.2

data/CHANGES

@@ -1,6 +1,10 @@
 = sdrt changelog
 
-== Master (for 0.0.2)
+== Master (for 0.0.3)
+
+== Version 0.0.2
+* Dates are changed to be shown in colors.
+* Dates which has no plan shows '(no plan)'
 
 == Version 0.0.1
 * Enable to use date and time.

data/Gemfile

@@ -6,9 +6,10 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.11.0"
+  gem "rspec", "~> 2.12.0"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.2.1"
   gem "jeweler", "~> 1.8.4"
   gem "simplecov", ">= 0"
+  gem "highline", ">= 1.6.15"
 end

data/README.rdoc

@@ -1,15 +1,104 @@
 = sculd
 
-4 types of Plan's; Reminder, Deadline, Schedule, Todo.
-  Reminder: nil till the date, REMINDER_PRIORITY at the date, decrease after that.
-  Deadline: nil till the date, REMINDER_PRIORITY at the beginning,
-    increase after that,
-    DEADLINE_PRIORITY at the deadline
-  Todo: nil till the date, REMINDER_PRIORITY at the date, increase after that,
-    DEADLINE_PRIORITY at the end.
-  Schedule: no priority.
-
-For tasks, two hight of priority are set; REMINDER_PRIORITY and DEADLINE_PRIORITY.
+Sculd, SChedULe Dealer, provides a command 'sculd'.
+The command reads ~/.sculd.dat, which is written by HOWM like
+format text file.
+It can contain four types of plans;
+* Reminder
+* Deadline
+* Schedule
+* Todo
+Each plan generate events and a task.
+Command 'sculd' output events divided to each day
+and tasks which have high priorities.
+
+== word: plan, event, task
+Word "plan" is a summarizing name for below;
+* Reminder
+* Deadline
+* Schedule
+* Todo
+
+"event" indicates an occurance which do not need preparation.
+
+"task" indicates a work which you need to consume time.
+
+(MEMO: Event and Task can have a parent class "Job". But not so now.)
+
+== plan
+A typical example of a plan, e.g., deadline, is denoted below;
+"[2012-11-04]!10 descriptionA."
+"[2012-11-04]" is a date time part.
+"!" is a plan type indicator.
+"10" is an option for type indicator.
+"descriptionA." is a description part.
+
+=== date time part
+Digits included by square bracket indicates date.
+This can be any format if Ruby DateTime::parse can interpret.
+
+This can include information of time, i.e.,
+"[2012-11-04 12:34:56]! descriptionA."
+
+And can also include information of weekday in parentheses, i.e.,
+"[2012-11-04 (Sun)]! descriptionA."
+If the weekday of the date is mismatched with the weekday in
+parentheses, 'sculd' outputs an error and stops.
+This may be useful to confirm that the plan is correct.
+
+=== plan type indicates
+"-": reminder
+"!": deadline
+"@": schedule
+"+": todo
+
+
+=== priority
+Two hight of priority are set for tasks;
+REMINDER_PRIORITY (10000)
+DEADLINE_PRIORITY (20000)
+
+=== Reminder
+Till   the date: no priority.
+On     the date: REMINDER_PRIORITY.
+After  the date: decrease gradually. (1 per day.)
+
+Option for indiccate doesn't have meaning and is ignored.
+A Reminder plan generates one event on the date.
+
+=== Schedule
+Always         : no priority.
+
+Option for indiccate doesn't have meaning and is ignored.
+A Schedule plan generates one event on the date.
+
+=== Deadline
+Till   the date: no priority.
+Starting   date: REMINDER_PRIORITY.
+During         : increase gradually. (linear)
+On     the date: DEADLINE_PRIORITY.
+After  the date: DEADLINE_PRIORITY, keeping.
+
+Starting date is (the_date - option).
+For example, Starting date of "[2012-11-14]!10 abc" is [2012-11-04].
+The default value for the option is seven.
+
+A Deadline plan generates two events;
+on the starting date and the last date.
+
+=== Todo
+Till   the date: no priority.
+On     the date: REMINDER_PRIORITY.
+During         : increase gradually. (linear)
+Last       date: DEADLINE_PRIORITY.
+After  the date: DEADLINE_PRIORITY, keeping.
+
+Todo is very similar to Deadline.
+Only a difference is that the last day is given to deadline and
+the first day is given to todo.
+
+A Todo plan generates two events;
+on the starting date and the last date.
 
 
 == Contributing to sculd

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/sculd

@@ -47,7 +47,8 @@ rescue Sculd::Manager::LoadError
   puts "Exit."
   exit
 end
-sm.show(OPTS[:event], OPTS[:task])
+io = $stdout
+sm.show(OPTS[:event], OPTS[:task], io)
 
 #while (true)
 #  s.show(OPTS[:event], OPTS[:task])

data/lib/sculd/manager.rb

@@ -3,6 +3,10 @@
 
 require "date"
 require "sculd.rb"
+
+require "rubygems"
+gem     "highline"
+require "highline"
 #require "/home/ippei/devel/sculd/lib/sculd.rb"
 
 #
@@ -20,7 +24,7 @@ class Sculd::Manager
     load_file(@source_file, io)
   end
 
-  def show(num_event, num_task)
+  def show(num_event, num_task, io = $stdout)
     show_events(num_event)
     show_tasks(num_task)
   end
@@ -63,21 +67,36 @@ class Sculd::Manager
   # Show events in 'num' days from todary.
   def show_events(num, today = Date.today, io = $stdout)
     return if num == 0
+    hl = HighLine.new($stdin, io)
 
     d_e = days_events
     io.puts "Events:"
     num.times do |i|
       date = today + i
+      str = " #{date.to_s} #{WEEKDAYS[date.wday]} "
+
+      case date.wday
+      when 0
+        hl.say("  <%= color('#{str}', :white, :on_red) %>")
+      when 6
+        hl.say("  <%= color('#{str}', :white, :on_blue) %>")
+      else
+        hl.say("  <%= color('#{str}', :white, :on_black) %>")
+      end
+
       events = d_e[date]
       if events # if plan is not empty.
-        io.puts "  #{date.to_s} #{WEEKDAYS[date.wday]}"
+        #HIGHLINE.say("<%= color('red', :red) %>!")
+        #HIGHLINE.say("  <%= color(#{date.to_s} #{WEEKDAYS[date.wday]}, :white, :red) %>")
+        #hl.say("  <%= color('red', :red) %>!")
+        #io.puts str
         events.sort_by{|i| i.datetime}.each do |job|
           io.puts "    #{job.description.strip}"
         end
-        io.puts
       else
-        next
+        io.puts "    (no plan)"
       end
+      io.puts
     end
   end
 

data/lib/sculd/plan.rb

@@ -36,9 +36,9 @@ class Sculd::Plan
       unless self.wday($1) == datetime.wday
         #io.puts "#{datetime} is #{Sculd::Manager::WEEKDAYS[datetime.wday]},"
         #io.puts "but string contains #{datestr}."
-        puts "ERROR:"
-        puts "#{datetime} is #{Sculd::Manager::WEEKDAYS[datetime.wday]},"
-        puts "but string contains #{datestr}."
+        io.puts "ERROR:"
+        io.puts "#{datetime} is #{Sculd::Manager::WEEKDAYS[datetime.wday]},"
+        io.puts "but string contains #{datestr}."
         raise WeekdayMismatchError
       end
     end

data/sculd.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sculd"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippei94da"]
-  s.date = "2012-11-01"
+  s.date = "2012-11-19"
   s.description = "Schedule management system using 'howm' like format. Plans, i.e., schedule(@), reminder(-), deadline(!), and tood(+), make events and tasks. Command 'sculd' can output events on each date and tasks with high priority. "
   s.email = "ippei94da@gmail.com"
   s.executables = ["dates", "sculd"]
@@ -63,24 +63,27 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.2.1"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<highline>, [">= 1.6.15"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.11.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.12.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.2.1"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<highline>, [">= 1.6.15"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.11.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.12.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.2.1"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<highline>, [">= 1.6.15"])
   end
 end
 

data/spec/manager_spec.rb

@@ -63,18 +63,19 @@ describe "Manager" do
     describe "#show_events" do
       it 'should return itemized days and events' do
         io = StringIO.new
-        today = Date.new(2012, 9,6)
-        @s01.show_events(10, today, io)
+        today = Date.new(2012, 9, 15)
+        @s01.show_events(2, today, io)
         io.rewind
         results = io.readlines
         #pp results
         results.size.should == 7
         results[0].should == "Events:\n"
-        results[1].should == "  2012-09-09 Sun\n"
-        results[2].should == "    [2012-09-16]! deadline b\n"
+        #results[1].should == "  2012-09-09 Sun\n"
+        results[1].should == "   2012-09-15 Sat \n"
+        results[2].should == "    [2012-09-15]@ schedule a\n"
         results[3].should == "\n"
-        results[4].should == "  2012-09-15 Sat\n"
-        results[5].should == "    [2012-09-15]@ schedule a\n"
+        results[4].should == "   2012-09-16 Sun \n"
+        results[5].should == "    [2012-09-16]! deadline b\n"
         results[6].should == "\n"
         #results[].should == "\n"
         #results[].should == "  [2012-09-16]\n"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sculd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-01 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &71356360 !ruby/object:Gem::Requirement
+  requirement: &75099820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *71356360
+  version_requirements: *75099820
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &71355770 !ruby/object:Gem::Requirement
+  requirement: &75099330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *71355770
+  version_requirements: *75099330
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &71355240 !ruby/object:Gem::Requirement
+  requirement: &75098960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *71355240
+  version_requirements: *75098960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &71354270 !ruby/object:Gem::Requirement
+  requirement: &75098570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *71354270
+  version_requirements: *75098570
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &71353730 !ruby/object:Gem::Requirement
+  requirement: &75096840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71353730
+  version_requirements: *75096840
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &74600910 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.15
+  type: :development
+  prerelease: false
+  version_requirements: *74600910
 description: ! 'Schedule management system using ''howm'' like format. Plans, i.e.,
   schedule(@), reminder(-), deadline(!), and tood(+), make events and tasks. Command
   ''sculd'' can output events on each date and tasks with high priority. '
@@ -127,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 229991729
+      hash: -143096045
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: