feedcellar 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 616ba2dcc5f71090f0cf437817a18182af508d37
-  data.tar.gz: 02438faff33f59e0e6b6c7ac529bdcb1e24ba191
+  metadata.gz: 043688575adc2059f4f67363860f3f200efd2008
+  data.tar.gz: 15b35303185ebc4c4267d2b2125dc71a3393e948
 SHA512:
-  metadata.gz: ba9a911ae57ad0758ae5652caf90edcabfc3d630703d5a7cf9bdd08af9b9dea87c776887eaef6136e286dcf04a62ffce07ac8bf3a3cfc590d3ed9f9b95467721
-  data.tar.gz: ef820e614e5373c8af03734ca4af31283b4fd7c81c47ebfa224a3ddf29cf73c99423c32ff6c22fad8f9bc32c6486baf54309fe144ffc898ff9ec5103f9a4afd6
+  metadata.gz: f6dacd8a9f1b500b211038399634153ee7fcd0066d6d0300f3efbd7b655620d2fc0b8a4e7add5430c0075222e8b9eeaf37edda0db55ceab8e442df4f69f3aea0
+  data.tar.gz: cac123ca7f2c0bf5d2c1a317bc36f068df440d77209718f7b8ae114004e9cf8ba51cda4079bb3aca0e3ab6cbe6fdeae20824f679e634da25744bf35b32d5cd11

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/var/

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+before_install:
+  - curl --silent --location https://github.com/groonga/groonga/raw/master/data/travis/setup.sh | sh

data/NEWS.md

@@ -1,5 +1,16 @@
 # NEWS
 
+## 0.4.0: 2014-08-29
+
+Browser and GUI support!
+
+### Changes
+
+  * Improvements
+    * Added an interface for a web browser.
+    * Added show command and GUI window (experimental).
+    * Use LGPLv2.1 or later to license.
+
 ## 0.3.2: 2013-07-04
 
 A bug fix release of 0.3.1.

data/README.md

@@ -1,8 +1,14 @@
-# feedcellar - Searchable Storage
+# feedcellar - a feed reader
 
-Searchable storage for RSS feed reader.
+[![Build Status](https://secure.travis-ci.org/myokoym/feedcellar.png?branch=master)](http://travis-ci.org/myokoym/feedcellar)
 
-Powered by rroonga with groonga.
+Feedcellar is a full-text searchable RSS feed reader and data store.
+
+Powered by [Groonga][] (via [Rroonga][]) with [Ruby][].
+
+[Groonga]:http://groonga.org/
+[Rroonga]:http://ranguba.org/#about-rroonga
+[Ruby]:https://www.ruby-lang.org/
 
 ## Installation
 
@@ -20,48 +26,74 @@ Or install it yourself as:
 
 ## Usage
 
-Show help
+### Show help
 
     $ feedcellar
 
-Register URL
+### Register URL
 
     $ feedcellar register http://example.net/rss
 
-Import URL from OPML
+### Import URL from OPML
 
     $ feedcellar import registers.xml
 
-Export registerd resources to OPML to STDOUT
+### Export registerd resources to OPML to STDOUT
 
     $ feedcellar export
 
-Show registers
+### Show registers
 
     $ feedcellar list
 
-Collect feeds (It takes several minutes)
+### Collect feeds (It takes several minutes)
 
     $ feedcellar collect
 
-Word search from titles and descriptions
+### Word search from titles and descriptions
 
     $ feedcellar search ruby
 
-Rich view by curses (set as default since 0.4.0)
+### Show feeds in a web browser
+
+    $ feedcellar web [--silent]
+
+Or
+
+    $ rackup
+
+#### Enable cache (using Racknga)
+
+    $ FEEDCELLAR_ENABLE_CACHE=true rackup
 
+### Show feeds on GUI window (experimental)
+
+    $ gem install gtk2
+    $ feedcellar show [--lines=N]
+
+### Rich view by curses (experimental)
+
+    $ gem install curses  # for Ruby 2.1
     $ feedcellar search ruby --curses
 
     Keybind:
       j: down
       k: up
-      f, ENTER: open link on firefox
+      f, ENTER: open the link on Firefox
       q: quit
 
-Delete database
+### Delete database
 
     $ rm -r ~/.feedcellar
 
+## License
+
+Copyright (c) 2013-2014 Masafumi Yokoyama `<myokoym@gmail.com>`
+
+LGPLv2.1 or later.
+
+See 'license/lgpl-2.1.txt' or 'http://www.gnu.org/licenses/lgpl-2.1' for details.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+desc "Run test"
+task :test do
+  Bundler::GemHelper.install_tasks
+  ruby("test/run-test.rb")
+end
+
+task :default => :test

data/bin/feedcellar-clear-cache

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "racknga"
+require "racknga/cache_database"
+
+bin_dir = File.expand_path(File.dirname(__FILE__))
+base_dir = File.join(bin_dir, "..")
+
+cache_database_path = File.join(base_dir, "var", "cache", "db")
+cache_database = Racknga::CacheDatabase.new(cache_database_path)
+cache_database.purge_old_responses

data/config.ru

@@ -0,0 +1,16 @@
+base_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(base_dir, "lib")
+$LOAD_PATH.unshift(lib_dir)
+require "feedcellar/web"
+
+ENV["FEEDCELLAR_HOME"] ||= File.join(base_dir, ".feedcellar")
+
+if ENV["FEEDCELLAR_ENABLE_CACHE"]
+  require "racknga"
+  require "racknga/middleware/cache"
+
+  cache_database_path = File.join(base_dir, "var", "cache", "db")
+  use Racknga::Middleware::Cache, :database_path => cache_database_path
+end
+
+run Feedcellar::Web

data/feedcellar.gemspec

@@ -8,22 +8,27 @@ Gem::Specification.new do |spec|
   spec.version       = Feedcellar::VERSION
   spec.authors       = ["Masafumi Yokoyama"]
   spec.email         = ["myokoym@gmail.com"]
-  spec.description   = %q{Searchable storage for RSS feed reader by rroonga with groonga.}
-  spec.summary       = %q{Searchable Storage for Feed Reader}
+  spec.description   = %q{Feedcellar is a full-text searchable RSS feed reader and data store by Groonga (via Rroonga) with Ruby.}
+  spec.summary       = %q{Full-Text Searchable RSS Feed Reader by Groonga}
   spec.homepage      = "http://myokoym.net/feedcellar/"
-  spec.license       = "MIT"
+  spec.license       = "LGPLv2.1 or later"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency("rroonga")
+  spec.add_runtime_dependency("rroonga", ">= 3.0.4")
   spec.add_runtime_dependency("thor")
+  #spec.add_runtime_dependency("gtk2")
+  spec.add_runtime_dependency("sinatra")
+  spec.add_runtime_dependency("haml")
+  spec.add_runtime_dependency("launchy")
+  spec.add_runtime_dependency("racknga")
 
   spec.add_development_dependency("test-unit")
   spec.add_development_dependency("test-unit-notify")
   spec.add_development_dependency("test-unit-rr")
-  spec.add_development_dependency("bundler", "~> 1.3")
+  spec.add_development_dependency("bundler")
   spec.add_development_dependency("rake")
 end

data/lib/feedcellar/command.rb

@@ -10,9 +10,12 @@ module Feedcellar
   class Command < Thor
     map "-v" => :version
 
+    attr_reader :database_dir
+
     def initialize(*args)
       super
-      @base_dir = File.join(File.expand_path("~"), ".feedcellar")
+      default_base_dir = File.join(File.expand_path("~"), ".feedcellar")
+      @base_dir = ENV["FEEDCELLAR_HOME"] || default_base_dir
       @database_dir = File.join(@base_dir, "db")
     end
 
@@ -57,6 +60,21 @@ module Feedcellar
       end
     end
 
+    desc "show", "Show feeds on GUI."
+    option :lines, :type => :numeric, :aliases => "-n", :desc => "Number of lines"
+    def show
+      # TODO: Can we always require gtk2 gem?
+      begin
+        require "feedcellar/window"
+      rescue LoadError => e
+        $stderr.puts("#{e.class}: #{e.message}")
+        return false
+      end
+
+      window = Window.new(@database_dir, options)
+      window.run
+    end
+
     desc "list", "Show registered resources list of title and URL."
     def list
       GroongaDatabase.new.open(@database_dir) do |database|
@@ -90,16 +108,10 @@ module Feedcellar
     desc "latest", "Show latest feeds by resources."
     def latest
       GroongaDatabase.new.open(@database_dir) do |database|
-        feeds = database.feeds
-        # TODO: I want to use the groonga method for grouping.
-        feeds.group_by {|feed| feed.resource.xmlUrl }.each do |url, group|
-          latest_feed = group.sort_by {|feed| feed.date }.last
-          next unless latest_feed
-
-          title = latest_feed.title.gsub(/\n/, " ")
-          next unless title
-          date = latest_feed.date.strftime("%Y/%m/%d")
-          puts "#{date} #{title} - #{latest_feed.resource.title}"
+        GroongaSearcher.latest(database).each do |feed|
+          title = feed.title.gsub(/\n/, " ")
+          date = feed.date.strftime("%Y/%m/%d")
+          puts "#{date} #{title} - #{feed.resource.title}"
         end
       end
     end
@@ -110,6 +122,7 @@ module Feedcellar
     option :mtime, :type => :numeric, :desc => "feed's data was last modified n*24 hours ago."
     option :resource, :type => :string, :desc => "search of partial match by feed's resource url"
     option :curses, :type => :boolean, :desc => "rich view for easy web browse"
+    option :grouping, :type => :boolean, :desc => "group by resource"
     def search(*words)
       if words.empty? &&
          (options["resource"].nil? || options["resource"].empty?)
@@ -123,6 +136,10 @@ module Feedcellar
         if options[:curses]
           require "feedcellar/curses_view"
           CursesView.run(sorted_feeds)
+        elsif options[:grouping]
+          sorted_feeds.group("resource").each do |group|
+            puts "#{group.key.title} (#{group.n_sub_records})"
+          end
         else
           sorted_feeds.each do |feed|
             title = feed.title.gsub(/\n/, " ")
@@ -138,5 +155,15 @@ module Feedcellar
         end
       end
     end
+
+    desc "web", "Show feeds in a web browser"
+    option :silent, :type => :boolean, :desc => "Don't open in browser"
+    def web
+      require "feedcellar/web"
+      require "launchy"
+      web_server_thread = Thread.new { Feedcellar::Web.run! }
+      Launchy.open("http://localhost:4567") unless options[:silent]
+      web_server_thread.join
+    end
   end
 end

data/lib/feedcellar/curses_view.rb

@@ -8,12 +8,11 @@ module Feedcellar
       Curses.noecho
       Curses.nonl
 
-      feeds.each_with_index do |feed, i|
-        Curses.setpos(i, 0)
-        title = feed.title.gsub(/\n/, " ")
-        date = feed.date.strftime("%Y/%m/%d")
-        Curses.addstr("#{date} #{title}")
-      end
+      # TODO
+      feeds = feeds.to_a
+      feeds.reject! {|feed| feed.title.nil? }
+
+      render_feeds(feeds)
       Curses.setpos(0, 0)
 
       pos = 0
@@ -28,8 +27,24 @@ module Feedcellar
             Curses.setpos(pos, 0)
           when "f", 13
             spawn("firefox",
-                  feeds[pos + 1].link,
+                  feeds[pos].link,
                   [:out, :err] => "/dev/null")
+          when "d"
+            mainwin = Curses.stdscr
+            mainwin.clear
+            subwin = mainwin.subwin(mainwin.maxy, mainwin.maxx, 0, 0)
+            subwin.setpos(0, 0)
+            subwin.addstr(feeds[pos].title)
+            subwin.setpos(3, 0)
+            subwin.addstr(feeds[pos].resource.title)
+            subwin.setpos(6, 0)
+            subwin.addstr(feeds[pos].description)
+            subwin.refresh
+            Curses.getch
+            subwin.clear
+            subwin.close
+            render_feeds(feeds)
+            Curses.setpos(pos, 0)
           when "q"
             break
           end
@@ -38,5 +53,17 @@ module Feedcellar
         Curses.close_screen
       end
     end
+
+    module_function
+    def render_feeds(feeds)
+      feeds.each_with_index do |feed, i|
+        Curses.setpos(i, 0)
+        title = feed.title.gsub(/\n/, " ")
+        date = feed.date.strftime("%Y/%m/%d")
+        Curses.addstr("#{date} #{title}")
+      end
+    end
+
+    private_class_method :render_feeds
   end
 end

data/lib/feedcellar/groonga_database.rb

@@ -43,6 +43,10 @@ module Feedcellar
                       :date        => date)
     end
 
+    def delete(id)
+      feeds.delete(id)
+    end
+
     def unregister(title_or_url)
       resources.delete do |record|
         (record.title == title_or_url) |

data/lib/feedcellar/groonga_searcher.rb

@@ -3,38 +3,50 @@ module Feedcellar
     class << self
       def search(database, words, options)
         feeds = database.feeds
-        feeds = feeds.select do |feed|
-          expression = nil
-          words.each do |word|
-            sub_expression = (feed.title =~ word) |
-                             (feed.description =~ word)
-            if expression.nil?
-              expression = sub_expression
-            else
-              expression &= sub_expression
+
+        if (!words.nil? && !words.empty?) || options[:resource_id]
+          feeds = feeds.select do |feed|
+            expression = nil
+            words.each do |word|
+              sub_expression = (feed.title =~ word) |
+                               (feed.description =~ word)
+              if expression.nil?
+                expression = sub_expression
+              else
+                expression &= sub_expression
+              end
             end
-          end
 
-          if options[:mtime]
-            base_date = (Time.now - (options[:mtime] * 60 * 60 * 24))
-            mtime_expression = feed.date > base_date
-            if expression.nil?
-              expression = mtime_expression
-            else
-              expression &= mtime_expression
+            if options[:mtime]
+              base_date = (Time.now - (options[:mtime] * 60 * 60 * 24))
+              mtime_expression = feed.date > base_date
+              if expression.nil?
+                expression = mtime_expression
+              else
+                expression &= mtime_expression
+              end
             end
-          end
 
-          if options[:resource]
-            resource_expression = feed.resource =~ options[:resource]
-            if expression.nil?
-              expression = resource_expression
-            else
-              expression &= resource_expression
+            if options[:resource]
+              resource_expression = feed.resource =~ options[:resource]
+              if expression.nil?
+                expression = resource_expression
+              else
+                expression &= resource_expression
+              end
             end
-          end
 
-          expression
+            if options[:resource_id]
+              resource_expression = feed.resource._id == options[:resource_id]
+              if expression.nil?
+                expression = resource_expression
+              else
+                expression &= resource_expression
+              end
+            end
+
+            expression
+          end
         end
 
         order = options[:reverse] ? "ascending" : "descending"
@@ -42,6 +54,20 @@ module Feedcellar
 
         sorted_feeds
       end
+
+      def latest(database)
+        latest_feeds = []
+
+        feeds = database.feeds
+        feeds.group("resource.xmlUrl", :max_n_sub_records => 1).each do |group|
+          latest_feed = group.sub_records[0]
+          next unless latest_feed
+          next unless latest_feed.title
+          latest_feeds << latest_feed
+        end
+
+        latest_feeds
+      end
     end
   end
 end

data/lib/feedcellar/tree_view.rb

@@ -0,0 +1,131 @@
+# Copyright (C) 2014  Masafumi Yokoyama <myokoym@gmail.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "gtk2"
+require "erb"
+
+module Feedcellar
+  class TreeView < Gtk::TreeView
+    KEY_COLUMN, TITLE_COLUMN, LINK_COLUMN, DESCRIPTION_COLUMN, DATE_COLUMN, STRFTIME_COLUMN, RESOURCE_AND_TITLE_COLUMN = *0..6
+
+    def initialize(records)
+      super()
+      @model = Gtk::ListStore.new(String, String, String, String, Time, String, String)
+      create_tree(@model, records)
+    end
+
+    def next
+      move_cursor(Gtk::MovementStep::DISPLAY_LINES, 1)
+    end
+
+    def prev
+      move_cursor(Gtk::MovementStep::DISPLAY_LINES, -1)
+    end
+
+    def remove_selected_record
+      return nil unless selected_iter
+      @model.remove(selected_iter)
+    end
+
+    def get_link(path)
+      @model.get_iter(path).get_value(LINK_COLUMN)
+    end
+
+    def selected_key
+      return nil unless selected_iter
+      selected_iter.get_value(KEY_COLUMN)
+    end
+
+    def selected_title
+      return nil unless selected_iter
+      selected_iter.get_value(TITLE_COLUMN)
+    end
+
+    def selected_link
+      return nil unless selected_iter
+      selected_iter.get_value(LINK_COLUMN)
+    end
+
+    def selected_description
+      return nil unless selected_iter
+      selected_iter.get_value(DESCRIPTION_COLUMN)
+    end
+
+    def selected_date
+      return nil unless selected_iter
+      selected_iter.get_value(DATE_COLUMN)
+    end
+
+    def selected_iter
+      selection.selected
+    end
+
+    def update_model(records)
+      model = Gtk::ListStore.new(String, String, String, String, Time, String, String)
+      records.each do |record|
+        load_record(model, record)
+      end
+      set_model(model)
+      @model = model
+    end
+
+    private
+    def create_tree(model, records)
+      set_model(model)
+      self.search_column = TITLE_COLUMN
+      self.enable_search = false
+      self.rules_hint = true
+      self.tooltip_column = DESCRIPTION_COLUMN
+
+      selection.set_mode(:browse)
+
+      records.each do |record|
+        load_record(model, record)
+      end
+
+      column = create_column("Date", STRFTIME_COLUMN)
+      append_column(column)
+
+      column = create_column("Title", RESOURCE_AND_TITLE_COLUMN)
+      append_column(column)
+
+      expand_all
+    end
+
+    def create_column(title, index)
+      column = Gtk::TreeViewColumn.new
+      column.title = title
+      renderer = Gtk::CellRendererText.new
+      column.pack_start(renderer, :expand => false)
+      column.add_attribute(renderer, :text, index)
+      column.set_sort_column_id(index)
+      column
+    end
+
+    def load_record(model, record)
+      iter = model.append
+      iter.set_value(KEY_COLUMN, record._key)
+      iter.set_value(TITLE_COLUMN, record.title)
+      iter.set_value(LINK_COLUMN, record.link)
+      escaped_description = ERB::Util.html_escape(record.description)
+      iter.set_value(DESCRIPTION_COLUMN, escaped_description)
+      iter.set_value(DATE_COLUMN, record.date)
+      iter.set_value(STRFTIME_COLUMN, record.date.strftime("%Y-%m-%d\n%H:%M:%S"))
+      text = [record.resource.title, record.title].join("\n")
+      iter.set_value(RESOURCE_AND_TITLE_COLUMN, text)
+    end
+  end
+end

data/lib/feedcellar/version.rb

@@ -1,3 +1,3 @@
 module Feedcellar
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/feedcellar/views/index.haml

@@ -0,0 +1,13 @@
+%h1 feedcellar
+%p= "Powered by Groonga #{groonga_version} and Rroonga #{rroonga_version}."
+%form{:action => url("/search", false, true), :method => :get}
+  %input{:type => "textarea", :name => "word", :size => 20, :value => params[:word]}
+  %input{:type => "submit", :value => "Search"}
+- if @feeds
+  %p
+    - grouping(@feeds).each do |resource|
+      = markup_drilled_item(resource)
+  %ul
+    - @feeds.each do |feed|
+      %li
+        %a{:href => feed.link}= "#{feed.title} - #{feed.resource.title}"

data/lib/feedcellar/views/layout.haml

@@ -0,0 +1,6 @@
+!!!
+%html
+  %head
+    %title feedcellar
+  %body
+    = yield