feedcellar 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99485cd81b7d2ccc7e871f93c89f54d484c1a725
-  data.tar.gz: acf336156d13924926fe66805a457d7f6c574520
+  metadata.gz: e574a4dc6570abaed41db607382a859f4e99d245
+  data.tar.gz: 57d69eaac737b2f5369bd37cd67b8dc3e8292af2
 SHA512:
-  metadata.gz: ce6bbda93db793f7c36e82f6461890128dbb01031a2759ca2d8491a7bcae746e71329a3b01a9eb6218b2e2dcc0508104112d8e8ea0cf0fbe3419877b844c0266
-  data.tar.gz: 05daf037e95a72d01b876f20a8830f38d361c1cbc99bd63dc435715d84d42113473f53017964c46afb77bf8059fd79fb287fa90f1f1e6a44a1d011dcabdd492b
+  metadata.gz: 8a8dcd5f66b52a3036edb153abc251cef13015b77e7fd9ed3fd94b5aa6c257216d4da571bc0ba77a11e7dc3e77585b243c21ab94637dfcdab0663d90f2d2eda3
+  data.tar.gz: 1b9bdea33770e3959a27bedc815c4712d31d0eaefa9b3057d6d652556657bb888b9bdcf6e7c8455e7fe77f1ea0b7de2d883edc347bbd982cf8841afe18c3cd32

data/NEWS.md

@@ -1,5 +1,27 @@
 # NEWS
 
+## 0.2.0: 2013-06-09
+
+Improve something to do with output release!
+
+### Changes
+
+  * Improvements
+    * Change default format of search command to one liner
+    * Change registers list format to one liner
+    * Add export command
+    * Add unregister command
+    * Use "short_text" instead of "text"
+    * Support raw object for API access
+
+  * Fixes
+    * Convert line-feed to space in feed title
+    * Extract parse of URL for resource of feed
+    * Extract parse of RSS feed
+    * Fix default database directory
+    * Fix groonga zone
+    * Fix description and date for atom
+
 ## 0.1.3: 2013-06-06
 
 Experimental functions release!

data/README.md

@@ -32,6 +32,10 @@ Import URL from OPML
 
     $ feedcellar import registers.xml
 
+Export registerd resources to OPML to STDOUT
+
+    $ feedcellar export
+
 Show registers
 
     $ feedcellar list

data/TODO.md

@@ -3,5 +3,10 @@
 ## Improvements
 
   * Manage TAG outline from OPML format.
+  * Support pager option
+
+## Fixes
+
+  * Review table column types.
 
 ## Release

data/lib/feedcellar.rb

@@ -2,6 +2,8 @@ require "feedcellar/version"
 require "feedcellar/groonga_database"
 require "feedcellar/opml"
 require "feedcellar/command"
+require "feedcellar/resource"
+require "feedcellar/feed"
 
 module Feedcellar
 end

data/lib/feedcellar/command.rb

@@ -1,14 +1,16 @@
 require "thor"
-require "rss"
 require "feedcellar/version"
 require "feedcellar/groonga_database"
 require "feedcellar/opml"
+require "feedcellar/feed"
+require "feedcellar/resource"
 
 module Feedcellar
   class Command < Thor
     def initialize(*args)
       super
-      @work_dir = File.join(File.expand_path("~"), ".feedcellar")
+      @base_dir = File.join(File.expand_path("~"), ".feedcellar")
+      @database_dir = File.join(@base_dir, "db")
     end
 
     desc "version", "Show version number."
@@ -18,134 +20,93 @@ module Feedcellar
 
     desc "register URL", "Register a URL."
     def register(url)
-      @database = GroongaDatabase.new
-      @database.open(@work_dir) do |database|
-        begin
-          rss = RSS::Parser.parse(url)
-        rescue RSS::InvalidRSSError
-          rss = RSS::Parser.parse(url, false)
-        rescue
-          $stderr.puts "WARNNING: #{$!} (#{url})"
-          return 1
-        end
-
-        unless rss
-          $stderr.puts "ERROR: Invalid URL"
-          return 1
-        end
-
-        resource = {}
-        if rss.is_a?(RSS::Atom::Feed)
-          resource["xmlUrl"] = url
-          resource["title"] = rss.title.content
-          resource["htmlUrl"] = rss.link.href
-          resource["description"] = rss.dc_description
-        else
-          resource["xmlUrl"] = url
-          resource["title"] = rss.channel.title
-          resource["htmlUrl"] = rss.channel.link
-          resource["description"] = rss.channel.description
-        end
+      resource = Resource.parse(url)
+      return 1 unless resource
 
+      GroongaDatabase.new.open(@database_dir) do |database|
         database.register(resource["title"], resource)
       end
     end
 
+    desc "unregister TITLE_OR_URL", "Unregister a resource of feed."
+    def unregister(title_or_url)
+      GroongaDatabase.new.open(@database_dir) do |database|
+        database.unregister(title_or_url)
+      end
+    end
+
     desc "import FILE", "Import feed resources by OPML format."
     def import(opml_xml)
-      @database = GroongaDatabase.new
-      @database.open(@work_dir) do |database|
+      GroongaDatabase.new.open(@database_dir) do |database|
         Feedcellar::Opml.parse(opml_xml).each do |resource|
           database.register(resource["title"], resource)
         end
       end
     end
 
-    desc "list", "Show feed url list."
+    desc "export", "Export feed resources by OPML format."
+    def export
+      GroongaDatabase.new.open(@database_dir) do |database|
+        puts Opml.build(database.resources.records)
+      end
+    end
+
+    desc "list", "Show registered resources list of title and URL."
     def list
-      @database = GroongaDatabase.new
-      @database.open(@work_dir) do |database|
+      GroongaDatabase.new.open(@database_dir) do |database|
         database.resources.each do |record|
-          puts record.title
-          puts "  #{record.xmlUrl}"
-          puts
+          puts "#{record.title} #{record.xmlUrl}"
         end
       end
     end
 
-    desc "collect", "Collect feeds."
+    desc "collect", "Collect feeds from WWW."
     def collect
-      @database = GroongaDatabase.new
-      @database.open(@work_dir) do |database|
-        resources = database.resources
-
-        resources.each do |record|
+      GroongaDatabase.new.open(@database_dir) do |database|
+        database.resources.each do |record|
           feed_url = record["xmlUrl"]
           next unless feed_url
 
-          begin
-            rss = RSS::Parser.parse(feed_url)
-          rescue RSS::InvalidRSSError
-            begin
-              rss = RSS::Parser.parse(feed_url, false)
-            rescue
-              $stderr.puts "WARNNING: #{$!} (#{feed_url})"
-              next
-            end
-          rescue
-            $stderr.puts "WARNNING: #{$!} (#{feed_url})"
-            next
-          end
-          next unless rss
-
-          rss.items.each do |item|
-            if rss.is_a?(RSS::Atom::Feed)
-              title = item.title.content
-              link = item.link.href if item.link
-              description = item.dc_description
-              date = item.dc_date
-            else
-              title = item.title
-              link = item.link
-              description = item.description
-              date = item.date
-            end
-
-            unless link
-              $stderr.puts "WARNNING: missing link (#{title})"
-              next
-            end
-
-            database.add(feed_url, title, link, description, date)
+          items = Feed.parse(feed_url)
+          next unless items
+
+          items.each do |item|
+            database.add(feed_url,
+                         item.title,
+                         item.link,
+                         item.description,
+                         item.date)
           end
         end
       end
     end
 
-    desc "search WORD", "Search feeds."
+    desc "search WORD", "Search feeds from local database."
     option :desc, :type => :boolean, :aliases => "-d", :desc => "show description"
-    option :simple, :type => :boolean, :desc => "simple format as one liner"
     option :browser, :type => :boolean, :desc => "open *ALL* links in browser"
-    def search(word)
-      @database = GroongaDatabase.new
-      @database.open(@work_dir) do |database|
-        feeds = @database.feeds
-        resources = @database.resources
+    def search(word, api=false)
+      GroongaDatabase.new.open(@database_dir) do |database|
+        feeds = database.feeds
+        resources = database.resources
 
         records = feeds.select do |v|
           (v.title =~ word) | (v.description =~ word)
         end
 
-        records.sort([{:key => "date", :order => "ascending"}]).each do |record|
+        sorted_records = records.sort([{:key => "date", :order => "ascending"}])
+        return sorted_records if api
+
+        sorted_records.each do |record|
           feed_resources = resources.select {|v| v.xmlUrl =~ record.resource }
           next unless feed_resources
-          if options[:simple]
-            # TODO This format will be to default from 0.2.0
+          next unless feed_resources.first # FIXME
+
+          unless options[:desc]
             date = record.date.strftime("%Y/%m/%d")
-            title= record.title
+            title = record.title
             resource = feed_resources.first.title
             link = record.link
-            puts "#{date} #{title} - #{resource}"
+            puts "#{date} #{title.gsub(/\n/, " ")} - #{resource}"
           else
             puts feed_resources.first.title
             puts "  #{record.title}"

data/lib/feedcellar/feed.rb

@@ -0,0 +1,52 @@
+require "rss"
+
+module Feedcellar
+  class Feed
+    attr_reader :title, :link, :description, :date
+    def initialize(title, link, description, date)
+      @title = title
+      @link = link
+      @description = description
+      @date = date
+    end
+
+    def self.parse(feed_url)
+      feeds = []
+
+      begin
+        rss = RSS::Parser.parse(feed_url)
+      rescue RSS::InvalidRSSError
+        begin
+          rss = RSS::Parser.parse(feed_url, false)
+        rescue
+          $stderr.puts "WARNNING: #{$!} (#{feed_url})"
+          return nil
+        end
+      rescue
+        $stderr.puts "WARNNING: #{$!} (#{feed_url})"
+        return nil
+      end
+      return nil unless rss
+
+      rss.items.each do |item|
+        if rss.is_a?(RSS::Atom::Feed)
+          title = item.title.content
+          link = item.link.href if item.link
+          description = item.summary.content if item.summary
+          date = item.updated.content if item.updated
+        else
+          title = item.title
+          link = item.link
+          description = item.description
+          date = item.date
+        end
+
+        next unless link
+
+        feeds << new(title, link, description, date)
+      end
+
+      feeds
+    end
+  end
+end

data/lib/feedcellar/groonga_database.rb

@@ -39,6 +39,14 @@ module Feedcellar
                       :date        => date)
     end
 
+    def unregister(title_or_url)
+      feeds = Groonga["Resources"]
+      feeds.delete do |record|
+        (record.title == title_or_url) |
+        (record.xmlUrl == title_or_url)
+      end
+    end
+
     def close
       @database.close
       @database = nil
@@ -71,23 +79,23 @@ module Feedcellar
       Groonga::Schema.define do |schema|
         schema.create_table("Resources", :type => :hash) do |table|
           table.text("text")
-          table.text("isComment")
-          table.text("isBreakpoint")
-          table.text("created")
-          table.text("category")
+          table.short_text("isComment")
+          table.short_text("isBreakpoint")
+          table.short_text("created")
+          table.short_text("category")
           table.text("description")
-          table.text("url")
-          table.text("htmlUrl")
-          table.text("xmlUrl")
-          table.text("title")
-          table.text("version")
-          table.text("language")
+          table.short_text("url")
+          table.short_text("htmlUrl")
+          table.short_text("xmlUrl")
+          table.short_text("title")
+          table.short_text("version")
+          table.short_text("language")
         end
 
         schema.create_table("Feeds", :type => :hash) do |table|
-          table.text("resource")
-          table.text("title")
-          table.text("link")
+          table.short_text("resource")
+          table.short_text("title")
+          table.short_text("link")
           table.text("description")
           table.time("date")
         end

data/lib/feedcellar/opml.rb

@@ -31,5 +31,31 @@ module Feedcellar
       end
       outlines
     end
+
+    def self.build(items)
+      document = REXML::Document.new
+
+      xml_decl = REXML::XMLDecl.new
+      xml_decl.version = "1.0"
+      xml_decl.encoding = "UTF-8"
+      document.add(xml_decl)
+
+      root = document.add_element("opml")
+      root.add_attributes("version" => "1.0")
+
+      head = root.add_element("head")
+      title = head.add_element("title")
+      title.add_text("registers in feedcellar")
+
+      body = root.add_element("body")
+      items.each do |item|
+        outline = body.add_element("outline")
+        item.attributes.each do |key, value|
+          outline.add_attributes(key => value)
+        end
+      end
+
+      document.to_s
+    end
   end
 end

data/lib/feedcellar/resource.rb

@@ -0,0 +1,36 @@
+require "rss"
+
+module Feedcellar
+  class Resource
+    def self.parse(url)
+      begin
+        rss = RSS::Parser.parse(url)
+      rescue RSS::InvalidRSSError
+        rss = RSS::Parser.parse(url, false)
+      rescue
+        $stderr.puts "WARNNING: #{$!} (#{url})"
+        return nil
+      end
+
+      unless rss
+        $stderr.puts "ERROR: Invalid URL"
+        return nil
+      end
+
+      resource = {}
+      if rss.is_a?(RSS::Atom::Feed)
+        resource["xmlUrl"] = url
+        resource["title"] = rss.title.content
+        resource["htmlUrl"] = rss.link.href
+        resource["description"] = rss.dc_description
+      else
+        resource["xmlUrl"] = url
+        resource["title"] = rss.channel.title
+        resource["htmlUrl"] = rss.channel.link
+        resource["description"] = rss.channel.description
+      end
+
+      resource
+    end
+  end
+end

data/lib/feedcellar/version.rb

@@ -1,3 +1,3 @@
 module Feedcellar
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/test/test-command.rb

@@ -9,10 +9,11 @@ class CommandTest < Test::Unit::TestCase
     @tmpdir = File.join(File.dirname(__FILE__), "tmp", "database")
     FileUtils.mkdir_p(@tmpdir)
     @command = Feedcellar::Command.new
-    @command.instance_variable_set(:@work_dir, @tmpdir)
+    @command.instance_variable_set(:@database_dir, @tmpdir)
   end
 
   def test_command
+    # confirm version command
     s = ""
     io = StringIO.new(s)
     $stdout = io
@@ -20,6 +21,7 @@ class CommandTest < Test::Unit::TestCase
     assert_equal("#{Feedcellar::VERSION}\n", s)
     $stdout = STDOUT
 
+    # confirm register command if invalid URL
     s = ""
     io = StringIO.new(s)
     $stderr = io
@@ -27,12 +29,14 @@ class CommandTest < Test::Unit::TestCase
     assert_equal("ERROR: Invalid URL\n", s)
     $stderr = STDERR
 
+    # confirm register command
     @command.register("http://myokoym.github.io/entries.rss")
     @command.register("https://rubygems.org/gems/mister_fairy/versions.atom")
     Feedcellar::GroongaDatabase.new.open(@tmpdir) do |database|
       assert_equal(2, database.resources.size)
     end
 
+    # confirm import command
     file = File.join(File.dirname(__FILE__), "fixtures", "subscriptions.xml")
     @command.import(file)
     @command.collect
@@ -41,11 +45,48 @@ class CommandTest < Test::Unit::TestCase
       assert_true(database.feeds.count > 0)
     end
 
+    # confirm export command
+    s = ""
+    io = StringIO.new(s)
+    $stdout = io
+    @command.export
+    assert_equal(1, s.scan(/<opml/).size)
+    assert_equal(4, s.scan(/<outline/).size)
+    $stdout = STDOUT
+
+    # confirm search command
     s = ""
     io = StringIO.new(s)
     $stdout = io
     @command.search("ruby")
-    assert_true(s.size > 500)
+    assert_true(s.size > 100)
+
+    # confirm search command in case of API
+    s = ""
+    io = StringIO.new(s)
+    ret = @command.search("ruby", true)
+    assert_equal(Groonga::Array, ret.class)
+    assert_equal(0, s.size)
+    assert_not_equal(0, ret.size)
+    $stdout = STDOUT
+
+    # confirm unregister command
+    @command.unregister("my_letter")
+    Feedcellar::GroongaDatabase.new.open(@tmpdir) do |database|
+      assert_equal(3, database.resources.size)
+    end
+    @command.unregister("https://rubygems.org/gems/mister_fairy/versions.atom")
+    Feedcellar::GroongaDatabase.new.open(@tmpdir) do |database|
+      assert_equal(2, database.resources.size)
+    end
+
+    # confirm search command after unregister
+    s = ""
+    io = StringIO.new(s)
+    ret = @command.search("ruby", true)
+    assert_equal(Groonga::Array, ret.class)
+    assert_equal(0, s.size)
+    assert_not_equal(0, ret.size)
     $stdout = STDOUT
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feedcellar
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Masafumi Yokoyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rroonga
@@ -127,8 +127,10 @@ files:
 - feedcellar.gemspec
 - lib/feedcellar.rb
 - lib/feedcellar/command.rb
+- lib/feedcellar/feed.rb
 - lib/feedcellar/groonga_database.rb
 - lib/feedcellar/opml.rb
+- lib/feedcellar/resource.rb
 - lib/feedcellar/version.rb
 - test/fixtures/subscriptions.xml
 - test/run-test.rb