pluto-models 1.1.0

data/lib/pluto/formatter.rb

@@ -0,0 +1,81 @@
+module Pluto
+
+class Formatter
+
+  include LogUtils::Logging
+
+  include Models
+  include ManifestHelper
+  
+  include TextUtils::DateHelper  # e.g. lets us use time_ago_in_words
+  include TextUtils::HypertextHelper # e.g. lets us use link_to, strip_tags, sanitize, textify, etc.
+
+  def initialize( opts, config )
+    @opts    = opts
+    @config  = config
+  end
+
+  attr_reader :opts, :config, :site
+
+
+  def run( arg )
+    ### remove - always use make( site_key )
+    ## fix: change arg to planet_key or just key or similar
+    #  todo: rename run to some less generic  - merge/build/etc. ??
+    
+    site_key = arg
+    site_key = site_key.downcase.gsub('.ini','').gsub('.yml','')  # remove .ini|.yml extension if present
+
+    manifest_name = opts.manifest
+    output_path   = opts.output_path
+
+    make_for(site_key, manifest_name, output_path )
+  end
+
+
+  def make_for( site_key, manifest_name, output_path )
+
+    ## fix: remove reference to opts
+    ##  - e.g. now still used for auto-installer
+
+    manifest_name = manifest_name.downcase.gsub('.txt', '' )  # remove .txt if present
+
+    logger.debug "manifest=#{manifest_name}"
+
+    # check for matching manifests
+    manifests = installed_template_manifests.select { |m| m[0] == manifest_name+'.txt' }
+        
+    if manifests.empty?
+      
+      ### try - autodownload
+      puts "*** template pack '#{manifest_name}' not found; trying auto-install..."
+      
+      Installer.new( opts ).install( manifest_name )
+
+      ### try again
+      
+      # check for matching manifests
+      manifests = installed_template_manifests.select { |m| m[0] == manifest_name+'.txt' }
+      
+      if manifests.empty?
+         puts "*** error: unknown template pack '#{manifest_name}'; use pluto ls to list installed template packs"
+         exit 2
+      end
+    end
+
+    manifestsrc = manifests[0][1]
+    pakpath     = output_path
+
+    @site = Site.find_by_key( site_key )
+    if @site.nil?
+      puts "*** warn: no site with key '#{site_key}' found; using untitled site record"
+      @site = Site.new
+      @site.title = 'Planet Untitled'
+    end
+
+    Pakman::Templater.new.merge_pak( manifestsrc, pakpath, binding, site_key )
+  end
+
+end # class Formatter
+
+end # module Pluto

data/lib/pluto/installer.rb

@@ -0,0 +1,58 @@
+module Pluto
+
+class Installer
+
+### fix: remove opts, use config (wrapped!!)
+  
+  include LogUtils::Logging
+  
+  def initialize( opts )
+    @opts    = opts
+  end
+
+  attr_reader :opts
+
+
+  def install( shortcut_or_source )
+
+    logger.debug "fetch >#{shortcut_or_source}<"
+    
+    ## check for builtin shortcut (assume no / or \) 
+    if shortcut_or_source.index( '/' ).nil? && shortcut_or_source.index( '\\' ).nil?
+      shortcut = shortcut_or_source
+      sources = opts.map_fetch_shortcut( shortcut )
+
+      if sources.empty?
+        puts "** Error: No mapping found for shortcut '#{shortcut}'."
+        return
+      end
+      puts "  Mapping fetch shortcut '#{shortcut}' to: #{sources.join(',')}"
+    else
+      sources = [shortcut_or_source]  # pass arg through unmapped
+    end
+
+    sources.each do |source|
+      install_template( source )
+    end
+
+  end # method run
+
+
+  def install_template( src )
+    # src = 'http://github.com/geraldb/slideshow/raw/d98e5b02b87ee66485431b1bee8fb6378297bfe4/code/templates/fullerscreen.txt'
+    # src = 'http://github.com/geraldb/sandbox/raw/13d4fec0908fbfcc456b74dfe2f88621614b5244/s5blank/s5blank.txt'
+    uri = URI.parse( src )
+    logger.debug "scheme: #{uri.scheme}, host: #{uri.host}, port: #{uri.port}, path: #{uri.path}"
+
+    pakname = File.basename( uri.path ).downcase.gsub('.txt','')
+    pakpath = File.expand_path( "#{opts.config_path}/#{pakname}" )
+    
+    logger.debug "packname >#{pakname}<"
+    logger.debug "pakpath >#{pakpath}<"
+  
+    Pakman::Fetcher.new.fetch_pak( src, pakpath )
+  end
+
+end # class Installer
+
+end # module Pluto

data/lib/pluto/lister.rb

@@ -0,0 +1,42 @@
+module Pluto
+
+class Lister
+
+  include LogUtils::Logging
+
+  include ManifestHelper
+
+  def initialize( opts )
+    @opts    = opts
+  end
+
+  attr_reader :opts
+
+  def list
+    home = Env.home
+    ## replace home w/ ~ (to make out more readable (shorter))
+    ## e.g. use gsub( home, '~' )
+
+    puts ''
+    puts 'Installed template packs in search path'
+    
+    installed_template_manifest_patterns.each_with_index do |pattern,i|
+      puts "    [#{i+1}] #{pattern.gsub(home,'~')}"
+    end
+    puts '  include:'
+    
+    manifests = installed_template_manifests
+    if manifests.empty?
+      puts "    -- none --"
+    else
+      manifests.each do |manifest|
+        pakname      = manifest[0].gsub('.txt','')
+        manifestpath = manifest[1].gsub(home,'~')
+        puts "%16s (%s)" % [pakname,manifestpath]
+      end
+    end
+  end # method list
+
+end # class Lister
+
+end # module Pluto

data/lib/pluto/manifest_helpers.rb

@@ -0,0 +1,51 @@
+module Pluto
+
+module ManifestHelper
+
+  ## shared methods for handling manifest lookups
+  ##
+  #  note: required attribs (in host class) include:
+  #     - opts.config_path
+  
+  def installed_template_manifest_patterns
+
+    # 1) search .    # that is, working/current dir
+    # 2) search <config_dir>
+    # 3) search <gem>/templates
+
+### 
+# Note
+# -- for now - no longer ship w/ builtin template packs
+# - download on demand if needed
+
+    builtin_patterns = [
+##      "#{Pluto.root}/templates/*.txt"
+    ]
+    config_patterns  = [
+##      "#{File.expand_path(opts.config_path)}/*.txt",
+      "#{File.expand_path(opts.config_path)}/*/*.txt"
+    ]
+    current_patterns = [
+##      "*.txt",
+      "*/*.txt",
+      "node_modules/*/*.txt", # note: add support for npm installs - use/make slideshow required in name? for namespace in the future???
+    ]
+
+    patterns = []
+    patterns += current_patterns
+    patterns += config_patterns
+    patterns += builtin_patterns
+  end
+
+  def installed_template_manifests
+    excludes = [
+      "Manifest.txt",
+      "*/Manifest.txt"
+    ]    
+    
+    Pakman::Finder.new.find_manifests( installed_template_manifest_patterns, excludes )
+  end
+
+
+end # module Manifest
+end # module Slideshow

data/lib/pluto/models.rb

@@ -0,0 +1,130 @@
+# encoding: utf-8
+
+# core and stdlibs
+
+require 'yaml'
+require 'json'
+require 'uri'
+require 'pp'
+require 'fileutils'
+require 'logger'
+require 'date'
+require 'digest/md5'
+
+
+# 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 'feedutils'
+require 'textutils'
+
+require 'activityutils'
+
+require 'props/activerecord'
+require 'logutils/activerecord'
+
+
+# our own code
+
+require 'pluto/version'   # note: let version always get first
+require 'pluto/schema'
+require 'pluto/activerecord'
+
+require 'pluto/models/activity'
+require 'pluto/models/feed'
+require 'pluto/models/item'
+require 'pluto/models/site'
+require 'pluto/models/subscription'
+require 'pluto/models/utils'
+
+require 'pluto/manifest_helpers'
+require 'pluto/connecter'
+
+require 'pluto/installer'
+require 'pluto/fetcher'
+require 'pluto/refresher'
+require 'pluto/subscriber'
+require 'pluto/updater'
+require 'pluto/lister'
+require 'pluto/formatter'
+
+
+module Pluto
+
+  def self.connect!( config=nil )  # convenience shortcut
+    Connecter.new.connect!( config )
+  end
+
+
+  # todo: add alias update_site( config ) ??
+  def self.update_subscriptions( config )
+    Subscriber.new.update_subscriptions( config )
+  end
+
+  def self.update_feeds
+    Refresher.new.update_feeds
+  end
+
+  def self.update_sites
+    Refresher.new.update_sites
+  end
+
+  def self.load_tasks
+    # load all builtin Rake tasks (from tasks/*rake)
+    load 'pluto/tasks/env.rake'
+    load 'pluto/tasks/setup.rake'
+    load 'pluto/tasks/stats.rake'
+    load 'pluto/tasks/update.rake'
+  end
+
+end  # module Pluto
+
+
+
+######
+# todo - move to ext/array.rb or similar
+
+class Array
+
+  ## todo: check if there's already a builtin method for this
+  #
+  #  note:
+  #   in rails ary.in_groups(3)  results in
+  #          top-to-bottom, left-to-right.
+  #  and not left-to-right first and than top-to-bottom.
+  #
+  #  rename to in_groups_vertical(3) ???
+
+  def in_columns( cols )  # alias for convenience for chunks - needed? why? why not?
+    chunks( cols )
+  end
+
+  def chunks( number_of_chunks )
+    ## NB: use chunks - columns might be in use by ActiveRecord! 
+    ###
+    # e.g.
+    #  [1,2,3,4,5,6,7,8,9,10].columns(3)
+    #   becomes:
+    #  [[1,4,7,10],
+    #   [2,5,8],
+    #   [3,6,9]]
+
+    ## check/todo: make a copy of the array first??
+    #  for now reference to original items get added to columns
+    chunks = (1..number_of_chunks).collect { [] }
+    each_with_index do |item,index|
+      chunks[ index % number_of_chunks ] << item
+    end
+    chunks
+  end
+
+end
+
+
+# say hello
+puts Pluto.banner   if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG) 

data/lib/pluto/models/activity.rb

@@ -0,0 +1,8 @@
+module Pluto
+  module Models
+
+# add shortcut/alias
+Activity = ActivityDb::Models::Activity
+
+  end # module Models
+end # module Pluto

data/lib/pluto/models/feed.rb

@@ -0,0 +1,127 @@
+module Pluto
+  module Models
+
+class Feed < ActiveRecord::Base
+  self.table_name = 'feeds'
+
+  include Pluto::ActiveRecordMethods  # e.g. read_attribute_w_fallbacks
+
+  has_many :items
+  has_many :subscriptions
+  has_many :sites, :through => :subscriptions
+
+
+  def self.latest
+    # note: order by first non-null datetime field
+    #   coalesce - supported by sqlite (yes), postgres (yes)
+
+    # note: if not published, touched or built use hardcoded 1971-01-01 for now
+    ## order( "coalesce(published,touched,built,'1971-01-01') desc" )
+    order( "coalesce(feeds.last_published,'1971-01-01') desc" )
+  end
+
+  ##################################
+  # attribute reader aliases
+  #
+  #  todo: check if we can use alias_method :name, :title   - works for non-existing/on-demand-generated method too??
+
+  def name()        title;    end  # alias for title
+  def description() summary;  end  # alias for summary  -- also add descr shortcut??
+  def link()        url;      end  # alias for url
+  def feed()        feed_url; end  # alias for feed_url
+
+  def url?()           read_attribute(:url).present?;       end
+  def title?()         read_attribute(:title).present?;     end
+  def title2?()        read_attribute(:title2).present?;    end
+  def feed_url?()      read_attribute(:feed_url).present?;  end
+
+  def url()      read_attribute_w_fallbacks( :url,      :auto_url );      end
+  def title()    read_attribute_w_fallbacks( :title,    :auto_title );    end
+  def title2()   read_attribute_w_fallbacks( :title2,   :auto_title2 );   end
+  def feed_url() read_attribute_w_fallbacks( :feed_url, :auto_feed_url ); end
+
+
+  def published?()  read_attribute(:published).present?;  end
+  def touched?()    read_attribute(:touched).present?;    end
+
+
+  def published
+    ## todo/fix: use a new name - do NOT squeeze convenience lookup into existing
+    #    db backed attribute
+
+    read_attribute_w_fallbacks(
+       :published,  
+       :touched,     # try touched (aka updated (ATOM))
+       :built        # try build (aka lastBuildDate (RSS))
+    )
+  end
+
+
+  def debug=(value)  @debug = value;   end
+  def debug?()       @debug || false;  end
+
+  def save_from_struct!( data )
+
+    update_from_struct!( data )
+    
+    data.items.each do |item|
+
+      item_rec = Item.find_by_guid( item.guid )
+      if item_rec.nil?
+        item_rec  = Item.new
+        puts "** NEW | #{item.title}"
+      else
+        ## todo: check if any attribs changed
+        puts "UPDATE | #{item.title}"
+      end
+      
+      item_rec.debug = debug? ? true : false  # pass along debug flag
+      item_rec.update_from_struct!( self, item )
+
+    end  # each item
+  end
+
+
+  def update_from_struct!( data )
+
+    ## todo: move to FeedUtils::Feed ??? why? why not??
+    if data.generator
+      generator_full = ''
+      generator_full << data.generator
+      generator_full << " @version=#{data.generator_version}"   if data.generator_version
+      generator_full << " @uri=#{data.generator_uri}"           if data.generator_uri
+    else
+      generator_full = nil
+    end
+
+    feed_attribs = {
+        format:       data.format,
+        published:    data.published,
+        touched:      data.updated,
+        built:        data.built,
+        summary:      data.summary,
+        ### todo/fix: add/use
+        # auto_title:     ???,
+        # auto_url:       ???,
+        # auto_feed_url:  ???,
+        auto_title2:  data.title2,
+        generator:    generator_full
+      }
+
+    if debug?
+        ## puts "*** dump feed_attribs:"
+        ## pp feed_attribs
+        puts "*** dump feed_attribs w/ class types:"
+        feed_attribs.each do |key,value|
+          puts "  #{key}: >#{value}< : #{value.class.name}"
+        end
+    end
+
+    update_attributes!( feed_attribs )
+  end
+
+end  # class Feed
+
+
+  end # module Models
+end # module Pluto