feedcellar-web 0.1.0

data/README.md

@@ -0,0 +1,49 @@
+# feedcellar-web
+
+[![Gem Version](https://badge.fury.io/rb/feedcellar-web.svg)](http://badge.fury.io/rb/feedcellar-web)
+
+Feedcellar::Web is a Web interface for [Feedcellar][] that is full-text searchable RSS feed reader and data store.
+
+[Feedcellar]:http://myokoym.net/feedcellar/
+
+## Demo
+
+http://myokoym.net/feedcellar-demo/
+
+## Installation
+
+    $ gem install feedcellar-web
+
+## Usage
+
+### Show help
+
+    $ feedcellar-web
+
+### Show feeds in a web browser
+
+    $ feedcellar-web start [--silent]
+
+Or
+
+    $ rackup
+
+#### Enable cache (using Racknga)
+
+    $ FEEDCELLAR_ENABLE_CACHE=true rackup
+
+## License
+
+Copyright (c) 2013-2015 Masafumi Yokoyama `<myokoym@gmail.com>`
+
+LGPLv2.1 or later.
+
+See 'LICENSE.txt' or 'http://www.gnu.org/licenses/lgpl-2.1' for details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+# Rakefile
+#
+# Copyright (C) 2013  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 "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-web

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#
+# executable: feedcellar-web
+#
+# Copyright (C) 2013-2015  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 "feedcellar/web/command"
+
+Feedcellar::Web::Command.start

data/config.ru

@@ -0,0 +1,34 @@
+# config.ru
+#
+# Copyright (C) 2014-2015  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
+
+base_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(base_dir, "lib")
+$LOAD_PATH.unshift(lib_dir)
+require "feedcellar/web/app"
+
+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::App

data/feedcellar-web.gemspec

@@ -0,0 +1,54 @@
+# coding: utf-8
+#
+# feedcellar-web.gemspec
+#
+# Copyright (C) 2013-2015  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
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feedcellar/web/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "feedcellar-web"
+  spec.version       = Feedcellar::Web::VERSION
+  spec.authors       = ["Masafumi Yokoyama"]
+  spec.email         = ["myokoym@gmail.com"]
+  spec.description   = %q{Feedcellar::Web is a Web interfface for Feedcellar that is a full-text searchable RSS feed reader and data store by Groonga (via Rroonga) with Ruby.}
+  spec.summary       = %q{Web interface for Feedcellar}
+  spec.homepage      = "http://myokoym.net/feedcellar/"
+  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("feedcellar", ">= 0.5.0")
+  spec.add_runtime_dependency("thor")
+  spec.add_runtime_dependency("sinatra")
+  spec.add_runtime_dependency("padrino-helpers")
+  spec.add_runtime_dependency("kaminari")
+  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")
+  spec.add_development_dependency("rake")
+end

data/lib/feedcellar/web/app.rb

@@ -0,0 +1,94 @@
+# class Feedcellar::Web::App
+#
+# Copyright (C) 2014-2015  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 "feedcellar"
+require "sinatra/base"
+require "haml"
+require "padrino-helpers"
+require "kaminari/sinatra"
+
+module Feedcellar
+  module Web
+    class App < Sinatra::Base
+      helpers Kaminari::Helpers::SinatraHelpers
+
+      get "/" do
+        haml :index
+      end
+
+      get "/search" do
+        if params[:word]
+          words = params[:word].split(" ")
+        else
+          words = []
+        end
+        options ||= {}
+        options[:resource_id] = params[:resource_id] if params[:resource_id]
+        @feeds = search(words, options)
+        if @feeds
+          page = params[:page]
+          n_per_page = options[:n_per_page] || 50
+          @paginated_feeds = pagenate_feeds(@feeds, page, n_per_page)
+        end
+        haml :index
+      end
+
+      get "/registers.opml" do
+        content_type :xml
+        opml = nil
+        GroongaDatabase.new.open(Command.new.database_dir) do |database|
+          opml = Opml.build(database.resources.records)
+        end
+        opml
+      end
+
+      helpers do
+        def search(words, options={})
+          database = GroongaDatabase.new
+          database.open(Command.new.database_dir)
+          GroongaSearcher.search(database, words, options)
+        end
+
+        def pagenate_feeds(feeds, page, n_per_page)
+          Kaminari.paginate_array(feeds.to_a).page(page).per(n_per_page)
+        end
+
+        def grouping(table)
+          key = "resource"
+          table.group(key).sort_by {|item| item.n_sub_records }.reverse
+        end
+
+        def drilled_url(resource)
+          url("/search?resource_id=#{resource._id}&word=#{params[:word]}")
+        end
+
+        def drilled_label(resource)
+          "#{resource.title} (#{resource.n_sub_records})"
+        end
+
+        def groonga_version
+          Groonga::VERSION[0..2].join(".")
+        end
+
+        def rroonga_version
+          Groonga::BINDINGS_VERSION.join(".")
+        end
+      end
+    end
+  end
+end

data/lib/feedcellar/web/command.rb

@@ -0,0 +1,51 @@
+# class Feedcellar::Web::Command
+#
+# Copyright (C) 2013-2015  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 "thor"
+require "launchy"
+require "feedcellar/web"
+
+module Feedcellar
+  module Web
+    class Command < Thor
+      map "-v" => :version
+
+      attr_reader :database_dir
+
+      def initialize(*args)
+        super
+        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
+
+      desc "version", "Show version number."
+      def version
+        puts Feedcellar::Web::VERSION
+      end
+
+      desc "start", "Start web server."
+      option :silent, :type => :boolean, :desc => "Don't open in browser"
+      def start
+        web_server_thread = Thread.new { Feedcellar::Web::App.run! }
+        Launchy.open("http://localhost:4567") unless options[:silent]
+        web_server_thread.join
+      end
+    end
+  end
+end

data/lib/feedcellar/web/version.rb

@@ -0,0 +1,23 @@
+# constant Feedcellar::Web::VERSION
+#
+# Copyright (C) 2015  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
+
+module Feedcellar
+  module Web
+    VERSION = "0.1.0"
+  end
+end

data/lib/feedcellar/web/views/index.haml

@@ -0,0 +1,16 @@
+%h1 feedcellar-web
+%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|
+      = link_to(drilled_label(resource), drilled_url(resource))
+  = paginate(@paginated_feeds)
+  %ul
+    - @paginated_feeds.each do |feed|
+      %li
+        %p
+          = link_to("#{feed.title} - #{feed.resource.title}", feed.link)
+  = paginate(@paginated_feeds)

data/lib/feedcellar/web/views/layout.haml

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

data/lib/feedcellar/web.rb

@@ -0,0 +1,20 @@
+# modlue Feedcellar::Web
+#
+# Copyright (C) 2013-2015  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 "feedcellar/web/version"
+require "feedcellar/web/app"

data/test/run-test.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+#
+# run-test.rb
+#
+# Copyright (C) 2013-2015  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 "test-unit"
+require "test/unit/notify"
+require "test/unit/rr"
+
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+lib_dir = File.join(base_dir, "lib")
+test_dir = File.join(base_dir, "test")
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.unshift(test_dir)
+
+exit Test::Unit::AutoRunner.run(true, test_dir)

data/test/test-app.rb

@@ -0,0 +1,14 @@
+require "rack/test"
+
+class AppTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    @app ||= Rack::Builder.parse_file("config.ru").first
+  end
+
+  def test_index
+    get "/"
+    assert_true(last_response.ok?)
+  end
+end

data/test/test-command.rb

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+#
+# class CommandTest
+#
+# Copyright (C) 2015  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 "fileutils"
+require "stringio"
+require "feedcellar/web/version"
+require "feedcellar/web/command"
+
+class CommandTest < Test::Unit::TestCase
+  def setup
+    @tmpdir = File.join(File.dirname(__FILE__), "tmp")
+    FileUtils.rm_rf(@tmpdir)
+    FileUtils.mkdir_p(@tmpdir)
+    ENV["FEEDCELLAR_HOME"] = @tmpdir
+    @command = Feedcellar::Web::Command.new
+    @database_dir = @command.database_dir
+  end
+
+  def teardown
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  def test_version
+    s = ""
+    io = StringIO.new(s)
+    $stdout = io
+    @command.version
+    assert_equal("#{Feedcellar::Web::VERSION}\n", s)
+    $stdout = STDOUT
+  end
+end