pluto 0.7.0 → 0.8.0

data/Manifest.txt

@@ -1,30 +1,19 @@
-History.markdown
+History.md
 Manifest.txt
-README.markdown
+README.md
 Rakefile
 bin/pluto
+config/pluto.index.yml
 lib/pluto.rb
+lib/pluto/cli/main.rb
 lib/pluto/cli/opts.rb
-lib/pluto/cli/runner.rb
 lib/pluto/connecter.rb
 lib/pluto/fetcher.rb
 lib/pluto/formatter.rb
+lib/pluto/installer.rb
+lib/pluto/lister.rb
+lib/pluto/manifest_helpers.rb
 lib/pluto/models.rb
 lib/pluto/schema.rb
-lib/pluto/server.rb
-lib/pluto/server/public/feed-icon-10x10.png
-lib/pluto/server/public/style.css
-lib/pluto/server/views/_debug.erb
-lib/pluto/server/views/_version.erb
-lib/pluto/server/views/debug.erb
-lib/pluto/server/views/feeds.erb
-lib/pluto/server/views/index.erb
-lib/pluto/server/views/items.erb
-lib/pluto/server/views/layout.erb
-lib/pluto/server/views/sites.erb
 lib/pluto/updater.rb
 lib/pluto/version.rb
-templates/blank.html.erb
-templates/blank.top.html.erb
-templates/blank.txt
-templates/feed-icon-10x10.png

data/README.md

@@ -0,0 +1,172 @@
+# pluto
+
+Another planet generator in ruby - lets you build web pages
+from published web feeds.
+
+* home  :: [github.com/feedreader/pluto](https://github.com/feedreader/pluto)
+* bugs  :: [github.com/feedreader/pluto/issues](https://github.com/feedreader/pluto/issues)
+* gem   :: [rubygems.org/gems/pluto](https://rubygems.org/gems/pluto)
+* rdoc  :: [rubydoc.info/gems/pluto](http://rubydoc.info/gems/pluto)
+
+
+## Usage
+
+Use the `pluto` command line tool and pass in one or more planet configuration files.
+Example:
+
+    pluto build ruby.yml        or
+    pluto b ruby
+
+This will
+
+1) fetch all feeds listed in `ruby.yml` and 
+
+2) store all entries in a local database, that is, `ruby.db` in your working folder and
+
+3) generate a planet web page, that is, `ruby.html` using the [`blank` template pack](https://github.com/feedreader/pluto.blank) in your working folder using all feed entries from the local database.
+
+Open up `ruby.html` to see your planet web page. Voila!
+
+
+### Command Line Tool
+
+~~~~
+NAME
+    pluto - another planet generator - lets you build web pages from published web feeds
+
+SYNOPSIS
+    pluto [global options] command [command options] [arguments...]
+
+GLOBAL OPTIONS
+    -c, --config=PATH - Configuration Path (default: ~/.pluto)
+    -q, --quiet       - Only show warnings, errors and fatal messages
+    --verbose         - (Debug) Show debug messages
+    --version         - Display the program version
+    --help            - Show this message
+
+COMMANDS
+    build, b    - Build planet
+    install, i  - Install template pack
+    list, ls, l - List installed template packs
+    about, a    - (Debug) Show more version info
+    help        - Shows a list of commands or help for one command
+~~~~
+
+#### `build` Command
+
+~~~
+NAME
+    build - Build planet
+
+SYNOPSIS
+    pluto [global options] build [command options] FILE
+
+COMMAND OPTIONS
+    -o, --output=PATH       - Output Path (default: .)
+    -t, --template=MANIFEST - Template Manifest (default: blank)
+    
+EXAMPLE
+    pluto build ruby.yml
+    pluto b ruby
+~~~
+
+#### `list` Command
+
+~~~
+NAME
+    list - List installed template packs
+
+SYNOPSIS
+    pluto [global options] list
+
+EXAMPLE
+   pluto list
+   pluto ls
+~~~
+
+#### `install` Command
+
+~~~
+NAME
+    install - Install template pack
+
+SYNOPSIS
+    pluto [global options] install MANIFEST
+
+EXAMPLE
+   pluto install news      # install "river of news" template pack
+~~~
+
+
+
+### Planet Configuration Sample 
+
+`ruby.yml`:
+
+```
+title: Planet Ruby
+
+feeds:
+  - rubyflow
+  - edgerails
+  - rubyonrails
+  - railstutorial
+
+rubyflow:
+  title: Ruby Flow
+  feed_url: http://feeds.feedburner.com/Rubyflow?format=xml
+  url: http://rubyflow.com
+
+edgerails:
+  title: What's new in Edge Rails?
+  feed_url:  http://www.edgerails.info/blog.atom
+  url: http://www.edgerails.info
+
+rubyonrails:
+  title: Ruby on Rails Blog
+  feed_url: http://weblog.rubyonrails.org/feed/atom.xml
+  url: http://weblog.rubyonrails.org
+
+railstutorial:
+  title: Rails Tutorial News
+  feed_url: http://feeds.feedburner.com/railstutorial?format=xml
+  url: http://news.railstutorial.org
+```
+
+For more samples, see [`nytimes.yml`](https://github.com/feedreader/pluto.samples/blob/master/nytimes.yml),
+[`js.yml`](https://github.com/feedreader/pluto.samples/blob/master/js.yml),
+[`dart.yml`](https://github.com/feedreader/pluto.samples/blob/master/dart.yml).
+
+
+## Install
+
+Just install the gem:
+
+    $ gem install pluto
+
+
+## Real World Usage
+
+[`pluto.live`](https://github.com/feedreader/pluto.live) - sample planet site; sinatra web app/starter template in ruby using the pluto gem
+
+
+
+## Alternatives
+
+### Ruby
+
+`planet.rb` by Akira Yamada [(Site)](http://planet.rubyforge.org)
+
+`Planet.rb` by Pablo Astigarraga [(Site)](https://github.com/pote/planet.rb)  - used with jekyll/octopress site generator
+
+### Python
+
+Planet Planet by Scott James Remnant n Jeff Waugh [(Site)](http://www.planetplanet.org)  - uses Mark Pilgrim's universal feed parser (RDF, RSS and Atom) and Tomas Styblo's templating engine
+
+Planet Venus by Sam Ruby [(Site)](https://github.com/rubys/venus) - cleaned up Planet Planet code
+
+
+## License
+
+The `pluto` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -8,22 +8,27 @@ Hoe.spec 'pluto' do
   self.summary = 'pluto - Another Planet Generator'
   self.description = 'pluto - Another Planet Generator (Lets You Build Web Pages from Published Web Feeds)'
 
-  self.urls    = ['https://github.com/geraldb/pluto']
+  self.urls    = ['https://github.com/feedreader/pluto']
 
   self.author  = 'Gerald Bauer'
   self.email   = 'webslideshow@googlegroups.com'
 
   # switch extension to .markdown for gihub formatting
-  self.readme_file  = 'README.markdown'
-  self.history_file = 'History.markdown'
+  self.readme_file  = 'README.md'
+  self.history_file = 'History.md'
 
   self.extra_deps = [
-    ['pakman', '>= 0.5'], 
-    ['fetcher', '>= 0.3'],
-    ['logutils', '>= 0.6']
+    ['pakman',    '>= 0.5'], 
+    ['fetcher',   '>= 0.3'],
+    ['logutils',  '>= 0.6'],
+    ['feedutils', '>= 0.3'],
+    ['props',     '>= 1.0.0'],
+    ['textutils', '>= 0.6.8'],    # future: add some filters (for include/exclude)
+    ['gli',       '>= 2.5.6']
     ## ['activerecord', '~> 3.2'],  #  NB:  soft dependency, will include activesupport,etc.
   ]
 
+
   self.licenses = ['Public Domain']
 
   self.spec_extras = {

data/config/pluto.index.yml

@@ -0,0 +1,19 @@
+#########################################
+# Pluto Update Index for Template Packs
+
+
+#############
+# shortcuts for fetching template packs
+#   maps shortcut to URI
+
+blank: https://raw.github.com/feedreader/pluto.blank/master/blank.txt
+
+top: https://raw.github.com/feedreader/pluto.top/master/top.txt
+
+news: https://raw.github.com/feedreader/pluto.news/master/news.txt
+
+
+####
+# all:
+#   - add why? why not??
+#

data/lib/pluto.rb

@@ -3,28 +3,26 @@
 #
 # 1.9.x: ruby -Ilib lib/pakman.rb
 
-# core and stlibs
+# core and stdlibs
 
 require 'yaml'
 require 'json'
 require 'uri'
 require 'pp'
-require 'logger'
 require 'optparse'
 require 'fileutils'
 
 
-
-require 'rss'
-
-# rubygems
+# 3rd party ruby gems/libs
 
 require 'active_record'   ## todo: add sqlite3? etc.
 
-
 require 'logutils'
+require 'props'     # manage settings/env
 require 'fetcher'   # fetch (download) files
-require 'pakman'    # template pack manager 
+require 'pakman'    # template pack manager
+require 'feedutils'
+require 'textutils'
 
 
 # our own code
@@ -32,13 +30,16 @@ require 'pakman'    # template pack manager
 require 'pluto/version'   # let version always get first
 require 'pluto/schema'
 require 'pluto/models'
+require 'pluto/manifest_helpers'
 require 'pluto/connecter'
+
+require 'pluto/installer'
 require 'pluto/updater'
 require 'pluto/fetcher'
+require 'pluto/lister'
 require 'pluto/formatter'
 
-require 'pluto/cli/opts'
-require 'pluto/cli/runner'
+require 'pluto/cli/opts'     ## fix: make sure fetcher/updater etc. do not depend on cli/opts
 
 module Pluto
 
@@ -62,10 +63,11 @@ module Pluto
     Updater.new.update_feeds
   end
 
-
   def self.main
-    Runner.new.run(ARGV)
+    require 'pluto/cli/main'
+    ## Runner.new.run(ARGV) - old code
   end
+  
 
 end  # module Pluto
 

data/lib/pluto/cli/main.rb

@@ -0,0 +1,213 @@
+# encoding: utf-8
+
+require 'gli'
+
+
+include GLI::App
+
+program_desc 'another planet generator (lets you build web pages from published web feeds)'
+version Pluto::VERSION
+
+
+## some setup code 
+
+LogUtils::Logger.root.level = :info   # set logging level to info 
+
+logger = LogUtils::Logger.root
+
+
+opts    = Pluto::Opts.new
+
+
+
+class SysInfo
+  
+  ## todo/fix:
+  ##   pass in/use config (props)
+  
+  def initialize( opts )
+    @opts = opts
+  end
+  
+  attr_reader :opts
+
+
+  def dump
+  puts <<EOS
+
+#{Pluto.banner}
+
+Gems versions:
+  - pakman #{Pakman::VERSION}
+  - fetcher #{Fetcher::VERSION}
+  - feedutils #{FeedUtils::VERSION}
+  - textutils #{TextUtils::VERSION}
+  - props #{Props::VERSION}
+
+    Env home: #{Env.home}
+Pluto config: #{opts.config_path}
+  Pluto root: #{Pluto.root}
+
+EOS
+
+  # dump Pluto settings
+  # config.dump
+  # puts
+      
+
+  ## todo: add more gem version info
+  # todo: add  logutils version
+  #       add  gli2     version
+  end
+
+end # class SysInfo
+
+
+
+
+## "global" options (switches/flags)
+
+desc '(Debug) Show debug messages'
+switch [:verbose], negatable: false    ## todo: use -w for short form? check ruby interpreter if in use too?
+
+desc 'Only show warnings, errors and fatal messages'
+switch [:q, :quiet], negatable: false
+
+
+desc 'Configuration Path'
+arg_name 'PATH'
+default_value opts.config_path
+flag [:c, :config] 
+
+
+desc 'Build planet'
+arg_name 'FILE', multiple: true   ## todo/fix: check multiple will not print typeo???
+command [:build, :b] do |c|
+
+  c.desc 'Output Path'
+  c.arg_name 'PATH'
+  c.default_value opts.output_path
+  c.flag [:o,:output]
+
+  c.desc 'Template Manifest'
+  c.arg_name 'MANIFEST'
+  c.default_value opts.manifest
+  c.flag [:t, :template]
+
+
+  c.action do |g,o,args|
+    logger.debug 'hello from build command'
+    
+    args.each do |arg|
+
+      name = File.basename( arg, '.*' )
+ 
+      db_config = {
+        adapter:  'sqlite3',
+        database: "#{opts.output_path}/#{name}.db"
+      }
+ 
+      Pluto::Connecter.new.connect!( db_config )
+
+      config_path = arg.dup   # add .yml file extension if missing (for convenience)
+      config_path << '.yml'  unless config_path.ends_with?( '.yml' )
+
+      config = YAML.load_file( config_path )
+      
+      puts "dump >#{config_path}<:"
+      pp config
+    
+      Pluto::Fetcher.new( opts, config ).run
+      Pluto::Formatter.new( opts, config ).run( name )
+      
+    end
+    
+    puts 'Done.'
+  end
+end # command build
+
+
+desc 'List installed template packs'
+command [:list,:ls,:l] do |c|
+
+  c.action do |g,o,args|
+    logger.debug 'hello from list command'
+
+    Pluto::Lister.new( opts ).list
+  end
+end
+
+
+desc 'Install template pack'
+arg_name 'MANIFEST', multiple: true
+command [:install,:i] do |c|
+
+  c.action do |g,o,args|
+    logger.debug 'hello from install command'
+        
+    args.each do |arg|
+      Pluto::Installer.new( opts ).install( arg )  ## todo: remove opts merge into config
+    end
+  end
+end
+
+
+desc '(Debug) Show more version info'
+skips_pre
+command [:about,:a] do |c|
+  c.action do
+    logger.debug 'hello from about command'
+
+    SysInfo.new( opts ).dump
+  end
+end
+
+
+desc '(Debug) Show global options, options, arguments for test command'
+command :test do |c|
+  c.action do |g,o,args|
+    puts 'hello from test command'
+    puts 'g/global_options:'
+    pp g
+    puts 'o/options:'
+    pp o
+    puts 'args:'
+    pp args
+  end
+end
+
+
+
+pre do |g,c,o,args|
+  opts.merge_gli_options!( g )
+  opts.merge_gli_options!( o )
+
+  puts Pluto.banner
+  
+  LogUtils::Logger.root.level = :debug    if opts.verbose?
+
+  logger.debug "   executing command #{c.name}"
+  true
+end
+
+
+post do |global,c,o,args|
+  logger.debug "   executed command #{c.name}"
+  true
+end
+
+
+on_error do |e|
+  puts
+  puts "*** error: #{e.message}"
+  puts
+
+  ## todo/fix: find a better way to print; just raise exception e.g. raise e  - why? why not??
+  ## puts e.backtrace.inspect  if opts.verbose?
+  raise e   if opts.verbose?
+
+  false # skip default error handling
+end
+
+
+exit run(ARGV)