cline 0.0.1 → 0.1.0

data/.gitignore

@@ -2,3 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage
+spec/tmp/*
+tmp/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=Fuubar

data/README.md

@@ -0,0 +1,96 @@
+# Cline - CLI Line Notifier
+
+## Installation
+
+~~~~
+  gem install cline
+  cline init
+  echo "Cline.out_stream = Cline::OutStreams::WithGrowl.new($stdout)" > ~/.cline/config # growlnotify required
+  echo "Cline.fetchers  << Cline::Fetchers::Feed" >> ~/.cline/config
+  curl http://foo.examle.com/url/to/opml.xml > ~/.cline/feeds.xml
+
+  cline fetch
+  cline tick --offset 0 --interval 5
+~~~~
+
+## Use case
+
+in ~/.screenrc
+
+~~~~
+  backtick 0 0 0 cline tick 0 60
+~~~~
+
+## initialize Database
+
+`init`command initialize new sqlite3 database.
+
+~~~~
+  cline init
+~~~~
+
+## Reload
+
+`fetch`command fetch new notifications from `Cline.fetchers`.
+
+~~~~
+  cline fetch
+~~~~
+
+### Custom Fetcher
+
+*fetcher* required `fetch` method.
+
+example:
+
+~~~~ruby
+  class MyFetcher
+    def self.fetch
+      new.sources.each do |source|
+        Cline::Notification.find_by_message(source.body) || Cline::Notification.create!(message: source.body, time: source.created_at)
+      end
+    end
+
+    def sources
+      # get new sources...
+    end
+  end
+~~~~
+
+### Registration
+
+in ~/.cline/config
+
+~~~~ruby
+  require 'path/to/my_fetcher'
+  Cline.fetchers << MyFetcher
+~~~~
+
+## Notifier
+
+`show` and `tick` command uses Cline's notifier.
+Default notifier is STDOUT.
+
+### Custom Notifyer
+
+Cline's notifier required `puts` instance method.
+
+example:
+
+~~~~ruby
+  class MyNotifier
+    def puts(str)
+      # implement notifier behaviour...
+    end
+  end
+~~~~
+
+### Registration
+
+in ~/.cline/config
+
+~~~~ruby
+  require 'path/to/my_notifier'
+  Cline.out_stream = MyNotifier
+~~~~
+

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/bin/cline

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require_relative '../lib/cline'
+
+begin
+  Cline::Command.start
+rescue Exception
+  Pathname.new("#{Cline.cline_dir}/log").open('a') do |f|
+    f.puts '---'
+    f.puts Time.now
+    f.puts $!.class
+    f.puts $!.message
+    f.puts $!.backtrace.join("\n")
+  end
+
+  raise $!
+end

data/cline.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["hibariya"]
   s.email       = ["celluloid.key@gmail.com"]
   s.homepage    = "https://github.com/hibariya/cline"
-  s.summary     = %q{CLI local news}
-  s.description = %q{TBA}
+  s.summary     = %q{CLI Line Notifier}
+  s.description = %q{Cline - CLI Line Notifier}
 
   #s.rubyforge_project = "cline"
 
@@ -21,4 +21,19 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
+
+  s.add_runtime_dependency 'thor', ['>= 0.14.6']
+  s.add_runtime_dependency 'activerecord', ['>= 3.1.1']
+  s.add_runtime_dependency 'sqlite3', ['>= 1.3.4']
+  s.add_runtime_dependency 'feedzirra', ['~> 0.0.31'] # FIXME builder dependency workaround...
+
+  s.add_development_dependency 'rake', ['>= 0.9.2']
+  s.add_development_dependency 'ir_b', ['>= 1.4.0']
+  s.add_development_dependency 'tapp', ['>= 1.1.0']
+  s.add_development_dependency 'rspec', ['>= 2.6.0']
+  s.add_development_dependency 'rr', ['>= 1.0.4']
+  s.add_development_dependency 'fabrication', ['>= 1.2.0']
+  s.add_development_dependency 'fuubar', ['>= 0.0.6']
+  s.add_development_dependency 'simplecov', ['>= 0.5.3']
+  s.add_development_dependency 'activesupport', ['>= 3.1.1']
 end

data/lib/cline/command.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+module Cline
+  class Command < Thor
+    def self.start(*)
+      Cline.boot
+      super
+    end
+
+    desc 'show', 'show a latest message'
+    method_options offset: :integer
+    def show(offset = options[:offset] || 0)
+      Notification.display offset
+    end
+
+    desc 'tick', 'rotate message'
+    method_options offset: :integer, interval: :integer
+    def tick(offset = options[:offset] || 0, interval = options[:interval] || 60)
+      loop do
+        show offset
+        sleep interval.to_i
+      end
+    end
+
+    desc 'status', 'show status'
+    def status
+      say "displayed : #{Notification.displayed.count}", :green
+      say "total     : #{Notification.count}", :cyan
+    end
+
+    desc 'fetch', 'fetch sources'
+    def fetch
+      Cline.fetchers.each &:fetch
+    end
+
+    desc 'init', 'init database'
+    def init
+      ActiveRecord::Base.connection.create_table(:notifications) do |t|
+        t.text    :message, null: false, default: ''
+        t.integer :display_count, null: false, default: 0
+        t.time    :time, null: false
+      end
+    end
+  end
+end

data/lib/cline/fetchers.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+module Cline::Fetchers
+  class Feed
+    def self.fetch
+      opml = Pathname.new("#{Cline.cline_dir}/feeds.xml")
+      entries = new(opml.read).fetch
+
+      entries.each do |entry|
+        message = "#{entry.title} #{entry.url}"
+        Cline::Notification.tap {|n| n.find_by_message(message) || n.create(message: message, time: entry.published) }
+      end
+    end
+
+    def initialize(opml_str)
+      require 'rexml/document'
+      require 'feedzirra'
+
+      @opml = REXML::Document.new(opml_str)
+      @feeds = parse_opml(@opml.elements['opml/body'])
+    end
+
+    def fetch
+      entries = []
+
+      @feeds.map { |feed_url|
+        Thread.fork do
+          begin
+            feed = Feedzirra::Feed.fetch_and_parse(feed_url)
+            entries += feed.entries if feed.is_a? Feedzirra::FeedUtilities
+          rescue
+            puts $!.class, $!.message
+          end
+        end
+      }.map(&:join)
+
+      entries
+    end
+
+    def parse_opml(opml_node)
+      feeds = []
+
+      opml_node.elements.each('outline') do |el|
+        unless el.elements.size.zero?
+          feeds += parse_opml(el) 
+        else
+          url = el.attributes['xmlUrl']
+          feeds << url if url
+        end
+      end
+
+      feeds
+    end
+  end
+end

data/lib/cline/notification.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+module Cline
+  class Notification < ActiveRecord::Base
+    validate :time, presence: true
+    validate :message, presence: true, uniqueness: true
+    validate :display_count, presence: true, numerically: true
+
+    scope :earliest, ->(limit = 1, offset = 0) {
+      order('display_count, time').limit(limit).offset(offset)
+    }
+
+    scope :displayed, where('display_count > 0')
+
+    class << self
+      def display(offset)
+        earliest(1, offset).first.display
+      end
+    end
+
+    def display
+      Cline.out_stream.puts display_message
+
+      increment! :display_count
+    end
+
+    def display_message
+      "[#{time}][#{display_count}] #{message}"
+    end
+  end
+end

data/lib/cline/out_streams.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+module Cline::OutStreams
+  class WithGrowl
+    attr_reader:stream
+
+    def initialize(stream = $stdout)
+      @stream = stream
+    end
+
+    def puts(str)
+      puts_stream str
+      puts_growlnotify str
+    end
+
+    private
+
+    def puts_stream(str)
+      stream.puts str
+    end
+
+    def puts_growlnotify(str)
+      `growlnotify -m '#{str}'`
+    end
+  end
+end

data/lib/cline/version.rb

@@ -1,3 +1,3 @@
 module Cline
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/cline.rb

@@ -1,5 +1,61 @@
-require "cline/version"
+# coding: utf-8
+
+here = File.dirname(__FILE__)
+$LOAD_PATH.unshift here unless $LOAD_PATH.include?(here)
 
 module Cline
-  # Your code goes here...
+  class << self
+    def cline_dir
+      "#{ENV['HOME']}/.cline"
+    end
+
+    def boot
+      mkdir_if_needed
+      setup_logger
+      establish_connection
+      load_config_if_exists
+    end
+
+    def mkdir_if_needed
+      path = Pathname.new(cline_dir)
+      path.mkdir unless path.directory?
+    end
+
+    def setup_logger
+      ActiveRecord::Base.logger = Logger.new(STDOUT)
+      ActiveRecord::Base.logger.level = Logger::WARN
+    end
+
+    def establish_connection
+      ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: "#{cline_dir}/cline.sqlite3", timeout: 10000
+    end
+
+    def load_config_if_exists
+      config = Pathname.new("#{cline_dir}/config")
+      load config if config.exist?
+    end
+
+    def out_stream
+      @out_stream || STDOUT
+    end
+
+    def out_stream=(stream)
+      @out_stream = stream
+    end
+
+    fetchers = []
+    define_method(:fetchers) { fetchers }
+  end
 end
+
+require 'logger'
+require 'pathname'
+require 'thor'
+require 'sqlite3'
+require 'active_record'
+
+require "cline/version"
+require "cline/notification"
+require "cline/command"
+require "cline/fetchers"
+require "cline/out_streams"

data/spec/fabricators.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+Fabricator(:notification, class_name: Cline::Notification) do
+  message { sequence(:message) {|i| "message ##{i}" } }
+  time { Time.now }
+end

data/spec/lib/cline_spec.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+require_relative '../spec_helper'
+
+describe Cline do
+  describe '#load_config_if_exists' do
+    let(:config) { Pathname.new(Cline.cline_dir).join('config') }
+
+    before do
+      config.open('w') {|f| f.puts "Cline.fetchers  << Cline::Fetchers::Feed" }
+
+      Cline.boot
+    end
+
+    specify "config file should loaded" do
+      Cline.fetchers.should include Cline::Fetchers::Feed
+    end
+
+    after do
+      config.unlink
+    end
+  end
+end

data/spec/lib/notification_spec.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+require_relative '../spec_helper'
+
+describe Cline::Notification do
+  describe '.ealiest' do
+    let!(:notification1) { Fabricate(:notification, time: 2.days.ago.beginning_of_day, display_count: 3) }
+    let!(:notification2) { Fabricate(:notification, time: 3.days.ago.beginning_of_day, display_count: 3) }
+    let!(:notification3) { Fabricate(:notification, time: 3.days.ago.beginning_of_day, display_count: 2) }
+
+    context 'default(limit 1 offset 0)' do
+      subject { Cline::Notification.earliest.all }
+
+      it { should == [notification3] }
+    end
+
+    context 'limit 2 offset 1' do
+      subject { Cline::Notification.earliest(2, 1).all }
+
+      it { should == [notification2, notification1] }
+    end
+  end
+
+  describe '.displayed' do
+    let!(:notification1) { Fabricate(:notification, display_count: 0) }
+    let!(:notification2) { Fabricate(:notification, display_count: 1) }
+
+    subject { Cline::Notification.displayed.all }
+
+    it { should == [notification2] }
+  end
+
+  describe '#display' do
+    let!(:notification) { Fabricate(:notification, display_count: 0) }
+
+    specify 'display_count should incremented' do
+      -> { notification.display }.should change(notification, :display_count).by(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+require 'tapp'
+require 'simplecov'
+require 'fabrication'
+
+SimpleCov.start
+
+CLINE_ROOT = Pathname.new(File.dirname(__FILE__) + '/../').realpath
+require_relative '../lib/cline'
+
+Dir[File.dirname(__FILE__) + '/support/*'].each {|f| require f }
+require_relative 'fabricators'
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.mock_with :rr
+
+  config.before(:suite) do
+    home = CLINE_ROOT.join('spec', 'tmp')
+    ENV['HOME'] = home.to_s
+
+    cline_dir = Pathname.new(Cline.cline_dir)
+    cline_dir.rmtree if cline_dir.directory?
+
+    Cline.boot
+    Cline::Command.new.invoke :init
+  end
+
+  config.before(:each) do
+    Cline.boot
+    Cline.out_stream = StringIO.new
+    Cline::Notification.delete_all
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cline
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,21 +9,177 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-22 00:00:00.000000000 Z
-dependencies: []
-description: TBA
+date: 2011-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70240666988320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70240666988320
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70240666984720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70240666984720
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70240666983100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70240666983100
+- !ruby/object:Gem::Dependency
+  name: feedzirra
+  requirement: &70240666980960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.31
+  type: :runtime
+  prerelease: false
+  version_requirements: *70240666980960
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70240666979860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70240666979860
+- !ruby/object:Gem::Dependency
+  name: ir_b
+  requirement: &70240666978660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70240666978660
+- !ruby/object:Gem::Dependency
+  name: tapp
+  requirement: &70240666977600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *70240666977600
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70240666976460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70240666976460
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70240666974980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: *70240666974980
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: &70240666973900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70240666973900
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: &70240666973120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :development
+  prerelease: false
+  version_requirements: *70240666973120
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70240666971520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: *70240666971520
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70240666970180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: *70240666970180
+description: Cline - CLI Line Notifier
 email:
 - celluloid.key@gmail.com
-executables: []
+executables:
+- cline
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
+- README.md
 - Rakefile
+- bin/cline
 - cline.gemspec
 - lib/cline.rb
+- lib/cline/command.rb
+- lib/cline/fetchers.rb
+- lib/cline/notification.rb
+- lib/cline/out_streams.rb
 - lib/cline/version.rb
+- spec/fabricators.rb
+- spec/lib/cline_spec.rb
+- spec/lib/notification_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
 homepage: https://github.com/hibariya/cline
 licenses: []
 post_install_message: 
@@ -44,8 +200,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: CLI local news
-test_files: []
+summary: CLI Line Notifier
+test_files:
+- spec/fabricators.rb
+- spec/lib/cline_spec.rb
+- spec/lib/notification_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep