bwkfanboy 1.3.0 → 1.3.1

data/README.rdoc

@@ -1,14 +1,5 @@
 = About
 
-(<b>If you cannot install the gem via normal <tt>gem install
-bwkfanboy</tt> command</b> then go to
-https://rubygems.org/gems/bwkfanboy and click 'Download' link, save the
-file and run:
-
-  # gem install -l /where/is/your/bwkfanboy-x.y.z.gem
-
-This problem arises with rubygems 1.5.0.)
-
 bwkfanboy is a HTML to Atom feed converter that you can use to watch
 sites that do not provide its own feed.
 
@@ -16,21 +7,42 @@ The converter is not a magick tool: you'll need to write a plugin (in
 Ruby) for each site you want to watch. bwkfanboy provides guidelines and
 general assistance.
 
-(Plugins included with bwkfanboy are usually updated more frequently
-than the whole gem on rubygems.org, so grab the source before
-struggling).
-
 Plugins from version 1.1.4 are *incompatible* with the 0.1.x
 series. Please reread in doc/plugin.rdoc the example of the skeleton
 plugin.
 
+= Included Plugins
+
+  NAME                 VER DESCRIPTION
+
+  bwk                    2 Brian Kernighan's articles from Daily Princetonian
+  freebsd-ports-update   3 News from FreeBSD ports
+  quora                 11 Last n answers (per-user) from Quora; requires nodejs 0.3.7+
+  econlib                1 Latest articles from econlib.org
+
+
+= Installation
+
+The easiest way is to type:
+
+  # gem install bwkfanboy
+
+Beware that plugins above are usually updated more frequently than the
+whole gem on rubygems.org, so grab the source before struggling with a
+particular plugin.
+
+If the setup with <tt>gem install ...</tt> fails, go to
+https://rubygems.org/gems/bwkfanboy and click 'Download' link, save the
+file and run:
+
+  # gem install -l /where/is/your/bwkfanboy-x.y.z.gem
+
+If even this doesn't help, drop me a email.
+
 = Architecture
 
 == Plugins
 
-bwkfanboy comes with several plugins. One of them, for example, parses a
-search page of dailyprincetonian.com looking for bwk's articles.
-
 The plugin is a Ruby class +Page+ that inherits Bwkfanboy::Parse parent,
 overriding 1 method.
 
@@ -105,4 +117,27 @@ There are 2 method to get an Atom feed via HTTP:
    directory. Read doc/bwkfanboy_server.rdoc to know how to operate it.
 
 = License
-:include: doc/LICENSE
+
+(The MIT License)
+
+Copyright (c) 2010 Alexander Gromnitsky.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -5,8 +5,10 @@ require 'rake/gempackagetask'
 require 'rake/clean'
 require 'rake/rdoctask'
 require 'rake/testtask'
+require 'json'
 
 require_relative 'test/rake_git'
+require_relative 'doc/rakefile'
 
 spec = Gem::Specification.new {|i|
   i.name = "bwkfanboy"
@@ -22,31 +24,37 @@ spec = Gem::Specification.new {|i|
 
   i.executables = FileList['bin/*'].gsub(/^bin\//, '')
   i.default_executable = i.name
-  
+
   i.test_files = FileList['test/test_*.rb']
-  
+
   i.rdoc_options << '-m' << 'doc/README.rdoc' << '-x' << 'plugins'
-  i.extra_rdoc_files = FileList['doc/*']
-  
+  i.extra_rdoc_files = FileList['doc/*.rdoc']
+
   i.add_dependency('open4', '>=  1.0.1')
-  i.add_dependency('activesupport', '>= 3.0.3')
+  i.add_dependency('activesupport', '>= 3.0.5')
   i.add_dependency('nokogiri', '>=  1.4.4')
-  i.add_dependency('jsonschema', '>= 2.0.0')
+  i.add_dependency('jsonschema', '>= 2.0.1')
 
   i.add_development_dependency('git', '>= 1.2.5')
 }
 
 Rake::GemPackageTask.new(spec).define
 
-task default: [:repackage]
+task gen_mydocs: ['mydocs:default'] do
+  spec.extra_rdoc_files.concat(MyDocs::RDOC_RELATIVE)
+end
+
+task default: [:gen_mydocs, :repackage]
+task doc: [:gen_mydocs, :rdoc]
+task clobber: ['mydocs:clean']
 
-Rake::RDocTask.new('doc') do |i|
-  i.main = 'doc/README.rdoc'
+Rake::RDocTask.new do |i|
   i.rdoc_files = FileList['doc/*', 'lib/**/*.rb']
   i.rdoc_files.exclude("lib/**/plugins")
+  i.main = 'doc/README.rdoc'
 end
 
 Rake::TestTask.new do |i|
-  i.test_files = FileList['test/test_*.rb'] 
+  i.test_files = FileList['test/test_*.rb']
   i.libs << '.'
 end

data/doc/NEWS.rdoc

@@ -1,3 +1,13 @@
+=== 1.3.1
+
+Thu Mar 17 17:19:52 EET 2011
+
+- Updated quora plugin.
+
+- Updated 1 test for jsonschema 2.0.1.
+
+- Updated the list of dependencies.
+
 === 1.3.0
 
 Thu Feb 10 11:17:57 EET 2011

data/doc/README.erb

@@ -0,0 +1,116 @@
+= About
+
+bwkfanboy is a HTML to Atom feed converter that you can use to watch
+sites that do not provide its own feed.
+
+The converter is not a magick tool: you'll need to write a plugin (in
+Ruby) for each site you want to watch. bwkfanboy provides guidelines and
+general assistance.
+
+Plugins from version 1.1.4 are *incompatible* with the 0.1.x
+series. Please reread in doc/plugin.rdoc the example of the skeleton
+plugin.
+
+= Included Plugins
+
+<% MyDocs.plugins.each { |i| %>  <%= i %>
+<% } %>
+
+= Installation
+
+The easiest way is to type:
+
+  # gem install bwkfanboy
+
+Beware that plugins above are usually updated more frequently than the
+whole gem on rubygems.org, so grab the source before struggling with a
+particular plugin.
+
+If the setup with <tt>gem install ...</tt> fails, go to
+https://rubygems.org/gems/bwkfanboy and click 'Download' link, save the
+file and run:
+
+  # gem install -l /where/is/your/bwkfanboy-x.y.z.gem
+
+If even this doesn't help, drop me a email.
+
+= Architecture
+
+== Plugins
+
+The plugin is a Ruby class +Page+ that inherits Bwkfanboy::Parse parent,
+overriding 1 method.
+
+Plugins can be in system
+
+  `gem env gemdir`/gems/bwkfanboy-x.y.z/lib/bwkfanboy/plugins
+
+or user's home
+
+  ~/.bwkfanboy/plugins
+
+directories.
+
+== Pipeline
+
+The program consists of 4 parts:
+
+0. *bwkfanboy* script that takes 1 parameter: the name of a file in
+   plugins directories (without the .rb suffix). So, for example to get
+   an atom feed from dailyprincetonian.com you type:
+
+     % bwkfanboy bwk
+
+   and it will load
+   <tt>/usr/local/lib/ruby/gems/1.9/gems/bwkfanboy-0.0.1/lib/bwkfanboy/plugins/bwk.rb</tt>
+   file on my FreeBSD machine, fetch and parse html from
+   dailyprincetonian.com and generate the required feed, dumping it to
+   stdout.
+
+   The script is just a convinient wrapper for 3 separate utils.
+
+1. *bwkfanboy_fetch*
+
+   It reads 1 line from stdin for the URL to fetch from. The result will
+   be dumped to stdout.
+
+2. *bwkfanboy_parse*
+
+   It takes 1 parameter: <em>a full path</em> to a plugin file.
+
+   This util reads stdin expecting it to be a xhtml, parses it and dumps
+   the result to stdout in JSON-formatted object.
+
+3. *bwkfanboy_generate*
+
+   Reads stdin expecting it to be a proper JSON-formatted object.
+
+   The result will be an Atom feed dumped to stdout in UTF-8.
+
+So, without the wrapper all this together looks like:
+
+  % echo http://example.org | bwkfanboy_fetch | 
+  	bwkfanboy_parse /path/to/my/plugin.rb | bwkfanboy_generate
+
+== Log
+
+All utils write to <tt>/tmp/bwkfanboy/USER/log/general.log</tt> file if
+permissions allows it.
+
+== HTTP
+
+There are 2 method to get an Atom feed via HTTP:
+
+1. <tt>web/bwkfanboy.cgi</tt> (from the program tarball), which you may
+   copy to your Apache cgi directory and run it. This prohibits you from
+   using HOME directory for your own plugins. Also the cgi script
+   requires some manual editing (setting 1 variable in it) before even
+   you can start utilizing it.
+
+2. Small *bwkfanboy_server* HTTP server. It can run from any user and
+   thus is able to inherit env variables for discovering your HOME
+   directory. Read doc/bwkfanboy_server.rdoc to know how to operate it.
+
+= License
+
+<%= File.read(MyDocs::PATH + 'LICENSE') %>

data/doc/README.rdoc

@@ -1,14 +1,5 @@
 = About
 
-(<b>If you cannot install the gem via normal <tt>gem install
-bwkfanboy</tt> command</b> then go to
-https://rubygems.org/gems/bwkfanboy and click 'Download' link, save the
-file and run:
-
-  # gem install -l /where/is/your/bwkfanboy-x.y.z.gem
-
-This problem arises with rubygems 1.5.0.)
-
 bwkfanboy is a HTML to Atom feed converter that you can use to watch
 sites that do not provide its own feed.
 
@@ -16,21 +7,42 @@ The converter is not a magick tool: you'll need to write a plugin (in
 Ruby) for each site you want to watch. bwkfanboy provides guidelines and
 general assistance.
 
-(Plugins included with bwkfanboy are usually updated more frequently
-than the whole gem on rubygems.org, so grab the source before
-struggling).
-
 Plugins from version 1.1.4 are *incompatible* with the 0.1.x
 series. Please reread in doc/plugin.rdoc the example of the skeleton
 plugin.
 
+= Included Plugins
+
+  NAME                 VER DESCRIPTION
+
+  bwk                    2 Brian Kernighan's articles from Daily Princetonian
+  freebsd-ports-update   3 News from FreeBSD ports
+  quora                 11 Last n answers (per-user) from Quora; requires nodejs 0.3.7+
+  econlib                1 Latest articles from econlib.org
+
+
+= Installation
+
+The easiest way is to type:
+
+  # gem install bwkfanboy
+
+Beware that plugins above are usually updated more frequently than the
+whole gem on rubygems.org, so grab the source before struggling with a
+particular plugin.
+
+If the setup with <tt>gem install ...</tt> fails, go to
+https://rubygems.org/gems/bwkfanboy and click 'Download' link, save the
+file and run:
+
+  # gem install -l /where/is/your/bwkfanboy-x.y.z.gem
+
+If even this doesn't help, drop me a email.
+
 = Architecture
 
 == Plugins
 
-bwkfanboy comes with several plugins. One of them, for example, parses a
-search page of dailyprincetonian.com looking for bwk's articles.
-
 The plugin is a Ruby class +Page+ that inherits Bwkfanboy::Parse parent,
 overriding 1 method.
 
@@ -105,4 +117,27 @@ There are 2 method to get an Atom feed via HTTP:
    directory. Read doc/bwkfanboy_server.rdoc to know how to operate it.
 
 = License
-:include: doc/LICENSE
+
+(The MIT License)
+
+Copyright (c) 2010 Alexander Gromnitsky.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/doc/rakefile.rb

@@ -0,0 +1,59 @@
+# -*-ruby-*-
+
+require 'erb'
+require 'json'
+require 'pathname'
+
+module MyDocs
+  PATH = Pathname.new File.dirname(__FILE__)
+
+  # our targets
+  RDOC = FileList["#{PATH}/*.erb"].sub(/\.erb$/, '.rdoc')
+  RDOC_RELATIVE = RDOC.pathmap '%-1d/%f'
+
+  BWK = PATH.parent + 'bin/bwkfanboy'
+  PLUGINS_DIR = PATH.parent + 'lib/bwkfanboy/plugins'
+  PLUGINS = Dir["#{PLUGINS_DIR}/*.rb"].map {|i| i.pathmap '%{\.rb$}f' }
+
+  # Return a list of plugins with description for each plugin.
+  # This is used in .erb files.
+  def self.plugins
+    plugin_name_max = 20
+
+    r = [format("%-#{plugin_name_max}s %s %s\n", 'NAME', 'VER', 'DESCRIPTION')]
+    PLUGINS.each {|i|
+      pr = `#{BWK} -i #{i} q w e r t y`.split("\n")
+      ver = pr[0].split(':')[1..-1].join.strip
+      desc = pr[2].split(':')[1..-1].join.strip
+      r << format("%-#{plugin_name_max}s %3s %s", i, ver, desc)
+    }
+    r
+  end
+end
+
+namespace 'mydocs' do
+  rule '.rdoc' => ['.erb'] do |i|
+    File.open(i.name, 'w+') {|fp|
+      puts i.source.pathmap('%-1d/%f') + ' > ' + i.name.pathmap('%-1d/%f')
+      fp.puts ERB.new(File.read(i.source)).result(binding)
+    }
+  end
+
+  desc "Generate all"
+  task :default => MyDocs::RDOC
+
+  desc "Clean all crap"
+  task :clean do
+    rm(MyDocs::RDOC, verbose: true, force: true)
+  end
+
+  desc "Print a list of plugins"
+  task :plugins do
+    MyDocs.plugins.each {|i| puts i}
+  end
+
+  desc "Print all staff that _can_ be generated"
+  task :print_gen do
+    puts MyDocs::RDOC.to_a.to_json
+  end
+end

data/lib/bwkfanboy/meta.rb

@@ -1,6 +1,6 @@
 module Bwkfanboy
   module Meta
     NAME = 'bwkfanboy'
-    VERSION = '1.3.0'
+    VERSION = '1.3.1'
   end
 end

data/lib/bwkfanboy/plugins/freebsd-ports-update.rb

@@ -5,7 +5,7 @@ class Page < Bwkfanboy::Parse
     URI = '/usr/ports/UPDATING'
     URI_DEBUG = URI
     ENC = 'ASCII'
-    VERSION = 2
+    VERSION = 3
     COPYRIGHT = "See bwkfanboy's LICENSE file"
     TITLE = "News from FreeBSD ports"
     CONTENT_TYPE = 'text'
@@ -28,7 +28,7 @@ class Page < Bwkfanboy::Parse
     re_u = /^(\d{8}):$/
     re_t1 = /^ {2}AFFECTS:\s+(.+)$/
     re_t2 = /^\s+(.+)$/
-    re_a = /^ {2}AUTHOR:\s+(.+)$/
+    re_a = /^ {2}AUTHORS?:\s+(.+)$/
 
     ready = false
     mode = nil

data/lib/bwkfanboy/plugins/quora.js

@@ -91,6 +91,8 @@ function prepare4eval(body) {
 "function QTextImageEnlarger(args) { return arr(arguments) }\n" +
 "function NavigatorResults(args) { return arr(arguments) }\n" +
 "function RateAnswerApproveButton(args) { return arr(arguments) }\n" +
+"function AnswerVoterNamesExpandable(args) { return arr(arguments) }\n" +
+"function PrefetchManager(args) { return arr(arguments) }\n" +
 	'';
 	var tail = "\n_components;\n";
 

data/lib/bwkfanboy/plugins/quora.rb

@@ -15,7 +15,7 @@ class Page < Bwkfanboy::Parse
     URI = 'http://www.quora.com/#{opt[0]}/answers'
     URI_DEBUG = '/home/alex/lib/software/alex/bwkfanboy/test/semis/quora.html'
     ENC = 'UTF-8'
-    VERSION = 10
+    VERSION = 11
     COPYRIGHT = "See bwkfanboy's LICENSE file"
     TITLE = "Last n answers (per-user) from Quora; requires nodejs 0.3.7+"
     CONTENT_TYPE = 'html'