pluto 0.8.2 → 0.8.3

data/Manifest.txt

@@ -14,7 +14,11 @@ lib/pluto/installer.rb
 lib/pluto/lister.rb
 lib/pluto/manifest_helpers.rb
 lib/pluto/models.rb
+lib/pluto/refresher.rb
 lib/pluto/schema.rb
+lib/pluto/subscriber.rb
 lib/pluto/template_helpers.rb
 lib/pluto/updater.rb
 lib/pluto/version.rb
+test/helper.rb
+test/test_helpers.rb

data/README.md

@@ -28,6 +28,11 @@ This will
 Open up `ruby.html` to see your planet web page. Voila!
 
 
+Note:  If you pass in no planet configuration files, the `pluto` command line tool will look
+for the default planet configuration files,
+that is, `pluto.ini`, `pluto.yml`, `planet.ini`, `planet.yml`.
+
+
 ### Command Line Tool
 
 ~~~~
@@ -48,10 +53,13 @@ COMMANDS
     build, b    - Build planet
     install, i  - Install template pack
     list, ls, l - List installed template packs
+    fetch, f    - Fetch planet feeds
+    merge, m    - Merge planet template pack
     about, a    - (Debug) Show more version info
     help        - Shows a list of commands or help for one command
 ~~~~
 
+
 #### `build` Command
 
 ~~~
@@ -68,8 +76,10 @@ COMMAND OPTIONS
 EXAMPLE
     pluto build ruby.yml
     pluto b ruby
+    pluto b            # will use pluto.ini|pluto.yml|planet.ini|planet.yml if present
 ~~~
 
+
 #### `list` Command
 
 ~~~
@@ -84,6 +94,7 @@ EXAMPLE
    pluto ls
 ~~~
 
+
 #### `install` Command
 
 ~~~
@@ -98,34 +109,85 @@ EXAMPLE
 ~~~
 
 
+#### `fetch` Command
+
+~~~
+NAME
+    fetch - Fetch planet feeds
+
+SYNOPSIS
+    pluto [global options] fetch FILE
+
+EXAMPLE
+    pluto fetch ruby.yml
+    pluto f ruby
+~~~
+
+
+#### `merge` Command
+
+~~~
+NAME
+    merge - Merge planet template pack
+
+SYNOPSIS
+    pluto [global options] merge [command options] FILE
+
+COMMAND OPTIONS
+    -o, --output=PATH       - Output Path (default: .)
+    -t, --template=MANIFEST - Template Manifest (default: blank)
+
+EXAMPLE
+    pluto merge ruby.yml
+    pluto m ruby
+~~~
+
+
+
 
 ### Planet Configuration Sample 
 
-`ruby.yml`:
+`ruby.ini`:
+
+```
+title = Planet Ruby
+
+[rubyflow]
+  title    = Ruby Flow
+  feed_url = http://feeds.feedburner.com/Rubyflow?format=xml
+  url      = http://rubyflow.com
+
+[rubyonrails]
+  title    = Ruby on Rails Blog
+  feed_url = http://weblog.rubyonrails.org/feed/atom.xml
+  url      = http://weblog.rubyonrails.org
+
+[viennarb]
+  title    = vienna.rb Blog
+  url      = http://vienna-rb.at
+  feed_url = http://vienna-rb.at/atom.xml
+```
+
+or `ruby.yml`:
 
 ```
 title: Planet Ruby
 
 
 rubyflow:
-  title: Ruby Flow
+  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
+  url:      http://rubyflow.com
 
 rubyonrails:
-  title: Ruby on Rails Blog
+  title:    Ruby on Rails Blog
   feed_url: http://weblog.rubyonrails.org/feed/atom.xml
-  url: http://weblog.rubyonrails.org
+  url:      http://weblog.rubyonrails.org
 
-railstutorial:
-  title: Rails Tutorial News
-  feed_url: http://feeds.feedburner.com/railstutorial?format=xml
-  url: http://news.railstutorial.org
+viennarb:
+  title:    vienna.rb Blog
+  url:      http://vienna-rb.at
+  feed_url: http://vienna-rb.at/atom.xml
 ```
 
 For more samples, see [`nytimes.yml`](https://github.com/feedreader/pluto.samples/blob/master/nytimes.yml),
@@ -152,16 +214,24 @@ Just install the gem:
 
 `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
+`planet.rb` by Pablo Astigarraga [(Site)](https://github.com/pote/planet.rb)  - used with jekyll/octopress site generator
+
+Planet Mars by Sam Ruby [(Site)](https://github.com/rubys/mars) -  first draft of cleaned up Planet Planet code; last change in 2008
 
 ### 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 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; last release version 2.0 in 2006
 
-Planet Venus by Sam Ruby [(Site)](https://github.com/rubys/venus) - cleaned up Planet Planet code
+Planet Venus by Sam Ruby [(Site)](https://github.com/rubys/venus) - cleaned up Planet Planet code; last change in 2010
 
 
 ## License
 
 The `pluto` scripts are dedicated to the public domain.
 Use it as you please with no restrictions whatsoever.
+
+## Questions? Comments?
+
+Questions? Comments?
+Send them along to the [Planet Pluto and Friends Forum/Mailing List](http://groups.google.com/group/feedreader).
+Thanks!

data/Rakefile

@@ -11,7 +11,7 @@ Hoe.spec 'pluto' do
   self.urls    = ['https://github.com/feedreader/pluto']
 
   self.author  = 'Gerald Bauer'
-  self.email   = 'webslideshow@googlegroups.com'
+  self.email   = 'feedreader@googlegroups.com'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
@@ -21,8 +21,8 @@ Hoe.spec 'pluto' do
     ['pakman',    '>= 0.5'], 
     ['fetcher',   '>= 0.3'],
     ['logutils',  '>= 0.6'],
-    ['feedutils', '>= 0.3'],
-    ['props',     '>= 1.0.0'],
+    ['feedutils', '>= 0.3.2'],    #  use min. 0.3.2 - added fix for rss.item.guid missing; no more auto-summary in atom
+    ['props',     '>= 1.0.2'],    #  use min. 1.0.2 - added ini support
     ['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.

data/lib/pluto.rb

@@ -36,8 +36,10 @@ require 'pluto/manifest_helpers'
 require 'pluto/connecter'
 
 require 'pluto/installer'
-require 'pluto/updater'
 require 'pluto/fetcher'
+require 'pluto/refresher'
+require 'pluto/subscriber'
+require 'pluto/updater'
 require 'pluto/lister'
 require 'pluto/template_helpers'
 require 'pluto/formatter'
@@ -59,11 +61,11 @@ module Pluto
   end
 
   def self.update_subscriptions( config )
-    Updater.new.update_subscriptions( config )
+    Subscriber.new.update_subscriptions( config )
   end
 
   def self.update_feeds
-    Updater.new.update_feeds
+    Refresher.new.update_feeds
   end
 
   def self.main

data/lib/pluto/cli/main.rb

@@ -64,6 +64,86 @@ end # class SysInfo
 
 
 
+######
+# begin
+#  move to pluto for reuse (e.g. in rakefile)
+
+def load_config( name )
+  extname = File.extname( name )   # return '' or '.ini' or '.yml' etc.
+
+  config = extname == '.ini' ? INI.load_file( name ) :
+                               YAML.load_file( name )
+
+  puts "dump >#{name}<:"
+  pp config
+
+  config
+end
+
+
+def find_default_config_path
+  candidates =  [ 'pluto.ini',
+                  'pluto.yml',
+                  'planet.ini',
+                  'planet.yml' ]
+
+  candidates.each do |candidate|
+    return candidate  if File.exists?( candidate )   ## todo: use ./candidate -- why? why not??
+  end
+
+  puts "*** note: no default planet configuration found, that is, no #{candidates.join('|')} found in working folder"
+  nil  # return nil; no conifg existing candidate found/present; sorry
+end
+
+
+def find_config_path( name )
+  extname    = File.extname( name )   # return '' or '.ini' or '.yml' etc.
+
+  return name  if extname.present?    # nothing to do; extension already present
+
+  candidates = [ '.ini', '.yml' ]
+
+  candidates.each do |candidate|
+    return "#{name}#{candidate}"  if File.exists?( "#{name}#{candidate}" )
+  end
+
+  # no extensions matching; sorry
+  puts "*** note: no configuration found w/ extensions #{candidates.join('|')} for '#{name}'"
+  # todo/check/fix - ?? -skip; remove from arg  - or just pass through ???
+  nil  # return nil; no config found/present; sorry
+end
+
+# end
+#  move to pluto for reuse (e.g. in rakefile)
+###########################
+
+
+def expand_config_args( args )
+
+  # 1) no args - try to find default config e.g. pluto.ini etc.
+  if args.length == 0      
+    new_arg = find_default_config_path
+    
+    return [] if new_arg.nil?
+    return [new_arg] # create a new args w/ one item e.g. ['pluto.yml']
+  end
+
+  # 2) expand extname if no extname and config present
+
+  new_args = []
+  args.each do |arg|
+    new_arg = find_config_path( arg )
+    if new_arg.nil?
+      # skip for now
+    else
+      new_args << new_arg
+    end
+  end
+  new_args
+  
+end # method expand_config_args
+
+
 
 ## "global" options (switches/flags)
 
@@ -99,18 +179,10 @@ command [:merge, :m] do |c|
   c.action do |g,o,args|
     logger.debug 'hello from merge command'
 
-    if args.length == 0
-      if File.exists?( 'pluto.yml' ) # check if pluto.yml exists, if yes add/use it
-        args = ['pluto.yml']  # create a new args w/ one item
-      elsif File.exists?( 'planet.yml' ) # check if planet.yml exists, if yes add/use it
-        args = ['planet.yml'] # create a new args w/ one item
-      else
-        puts '*** note: no arg passed in; no pluto.yml or planet.yml found in working folder'
-      end
-    end
+    args = expand_config_args( args )   # add missing .ini|.yml extension if missing or add default config (e.g. pluto.ini)
 
     args.each do |arg|
-      name = File.basename( arg, '.*' )
+      name    = File.basename( arg, '.*' )
 
       #####
       # todo: add into method for reuse for build/merge/fetch
@@ -120,16 +192,10 @@ command [:merge, :m] do |c|
         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' )
+      Pluto::Connecter.new.connect!( db_config )
 
-      config = YAML.load_file( config_path )
-      
-      puts "dump >#{config_path}<:"
-      pp config
+      config = load_config( arg )
     
       Pluto::Formatter.new( opts, config ).run( name )
     end
@@ -147,18 +213,10 @@ command [:fetch, :f] do |c|
   c.action do |g,o,args|
     logger.debug 'hello from fetch command'
 
-    if args.length == 0
-      if File.exists?( 'pluto.yml' ) # check if pluto.yml exists, if yes add/use it
-        args = ['pluto.yml']  # create a new args w/ one item
-      elsif File.exists?( 'planet.yml' ) # check if planet.yml exists, if yes add/use it
-        args = ['planet.yml'] # create a new args w/ one item
-      else
-        puts '*** note: no arg passed in; no pluto.yml or planet.yml found in working folder'
-      end
-    end
+    args = expand_config_args( args )   # add missing .ini|.yml extension if missing or add default config (e.g. pluto.ini)
 
     args.each do |arg|
-      name = File.basename( arg, '.*' )
+      name    = File.basename( arg, '.*' )
 
       #####
       # todo: add into method for reuse for build/merge/fetch
@@ -168,18 +226,12 @@ command [:fetch, :f] do |c|
         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 = load_config( arg )
 
-      config = YAML.load_file( config_path )
-      
-      puts "dump >#{config_path}<:"
-      pp config
-    
-      Pluto::Fetcher.new( opts, config ).run
+      Pluto::Updater.new( opts, config ).run
     end
     
     puts 'Done.'
@@ -206,38 +258,22 @@ command [:build, :b] do |c|
   c.action do |g,o,args|
     logger.debug 'hello from build command'
 
-    if args.length == 0
-      if File.exists?( 'pluto.yml' ) # check if pluto.yml exists, if yes add/use it
-        args = ['pluto.yml']  # create a new args w/ one item
-      elsif File.exists?( 'planet.yml' ) # check if planet.yml exists, if yes add/use it
-        args = ['planet.yml'] # create a new args w/ one item
-      else
-        puts '*** note: no arg passed in; no pluto.yml or planet.yml found in working folder'
-      end
-    end
+    args = expand_config_args( args )   # add missing .ini|.yml extension if missing or add default config (e.g. pluto.ini)
 
     args.each do |arg|
+      name    = File.basename( 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 = load_config( arg )
 
-      config = YAML.load_file( config_path )
-      
-      puts "dump >#{config_path}<:"
-      pp config
-    
-      Pluto::Fetcher.new( opts, config ).run
+      Pluto::Updater.new( opts, config ).run
       Pluto::Formatter.new( opts, config ).run( name )
-      
     end
     
     puts 'Done.'

data/lib/pluto/fetcher.rb

@@ -3,26 +3,8 @@ module Pluto
 
 class Fetcher
 
-  include LogUtils::Logging
-
-  def initialize( opts, config )
-    @opts    = opts
-    @config  = config
-  end
-
-  attr_reader :opts, :config
-
-
-  def run
-    updater = Updater.new
-
-    # pass along debug/verbose setting/switch
-    updater.debug = true    if opts.verbose?
-
-    updater.update_subscriptions( config )
-    updater.update_feeds
-  end # method run
-
+## todo: add fetch_feed machinery here
+#    now in refresher
 
 end # class Fetcher