fox 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 958a7a559e25d833355bdf0fffd38dac5a54d6d6
-  data.tar.gz: af8ee1fde1f1f28701dce0549736b9e6f536f15d
+  metadata.gz: 857965e1b8fd0f5c481aa1675971cb6e6479cec3
+  data.tar.gz: 0e1b11db7c1a364d0ee09eea0a2bbdfcf092d8d5
 SHA512:
-  metadata.gz: 587e812e9e989e5e936a3503af624fe4d4848b7243c679d23034076cbb9807a9b5f82f9b9e27f140c651f47bf50cbcc6a878949378826d4c038966c41498d2fd
-  data.tar.gz: de4e187eb5304bac91fffd4475ed344af4f05ea7305fa31eb0ea564d528d4baaa4136959f748db5e265ec5772750b00b60626e542fd435f0338acae6a6670328
+  metadata.gz: 31e854ae25a1280da10618176c53d4edba426e9b2e3b6f598bb1d5dbbeb671bd2e265ff0e6e150ae4c7b5aad630e7c69f2f9118ca16781c5258f692c925d7b4f
+  data.tar.gz: 8174e3766090b9d87a1649a1f4a08bd305829dcea65b4c8b10773eedac3c0fb0522c93b7b901cb50ec74cce5be625abc747b0d9489e4f6875a4da121476e8695

data/fox.gemspec

@@ -58,7 +58,8 @@ Gem::Specification.new do |spec|
 
   spec.files                += Dir.glob( 'spec/**/*' )
 
-  spec.files                += Dir.glob( 'data/**/*' )
+  # Exclude data folder (too big)
+  # spec.files                += Dir.glob( 'data/**/*' )
 
   spec.files                += Dir.glob( 'documentation/**/*' )
 
@@ -88,6 +89,8 @@ Gem::Specification.new do |spec|
   # Shell
   spec.add_runtime_dependency 'ptools'
   spec.add_runtime_dependency 'os'
+  spec.add_runtime_dependency 'progressbar'
+
 
   # Database ORM (Persistent)
   spec.add_runtime_dependency 'datamapper'
@@ -127,6 +130,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'andand'
   # spec.add_runtime_dependency 'ick'
 
+  # Audio
+  spec.add_runtime_dependency 'taglib-ruby'
+
   # Misc System
   # spec.add_runtime_dependency 'awesome_print'
   # spec.add_runtime_dependency 'uuid'

data/lib/fox/error/errors.rb

@@ -5,7 +5,6 @@
 # @brief          Fox module namespace
 module Fox
 
-
   class FoxError < StandardError
 
     class << self

data/lib/fox/interface/thor/mixin/audio.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+
+# System
+require 'taglib'
+require 'progressbar'
+
+
+# @module       module Mixin
+# @brief        Mixin module contains various functions to be used in other components
+module Mixin
+
+  # @module     Audio Module
+  # @brief      Module wrapper around audio tasks
+  module Audio
+
+    # @fn       def initialize *args {{{
+    # @brief    Default constructor
+    #
+    # @param    [Array]     args      Argument array
+    def initialize *args
+      super
+    end # }}}
+
+    # @fn       def play_remote url {{{
+    # @brief    Play audio content from remote URL
+    #
+    # @param    [String]      url     Remote URL
+    def play_remote url
+      play( url, :url )
+    end # }}}
+
+    # @fn       def play_local file {{{
+    # @brief    Play audio content file
+    #
+    # @param    [String]      file      Filename incl. path
+    def play_local file
+
+      duration = get_duration( file ) # in sec
+
+      if( duration.nil? )
+        play( file, :file )
+      else
+
+        threads     = []
+
+        threads     <<  Thread.new { play( file, :file ) }
+        threads     <<  Thread.new do
+          ProgressBar.new( "Pomodoro", duration.to_i ) do |bar|
+            duration.to_i.times { sleep(1); bar.inc }
+          end
+        end
+
+        threads.each { |thread| thread.join }
+
+      end # if( duration.nil? )
+
+    end # }}}
+
+
+    private
+
+    # in sec
+    def get_duration file
+
+      duration = nil
+
+      begin
+        TagLib::FileRef.open( file ) do |fileref|
+
+          unless fileref.null?
+            tag         = fileref.tag
+            properties  = fileref.audio_properties
+
+            duration    = properties.length
+          end
+
+        end # of TagLib
+      rescue
+      end
+
+      return duration
+    end
+
+
+    def play identifier, type
+
+      # Check if we are able to playback
+      sanity_check
+
+      if( type == :url )
+        # FIXME: Caching!
+        `wget #{identifier} -O - | mplayer -really-quiet -cache 8192 -`
+      end
+
+      if( type == :file )
+        `mplayer -really-quiet #{identifier}`
+      end
+
+    end
+
+    def sanity_check 
+      players = detect_available_players
+      # FIXME
+    end
+
+    # sorted after user preference
+    def detect_available_players
+      # FIXME
+      [ "mplayer" ]
+    end
+
+  end # of module Audio
+
+end # of module Mixin
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/fox/interface/thor/mixin/config.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+
+# System
+require 'fileutils'
+require 'ostruct'
+
+
+# @module       module Mixin
+# @brief        Mixin module contains various functions to be used in other components
+module Mixin
+
+  # @module     Config Module
+  # @brief      Module wrapper around tasks which demands config file
+  module Config
+
+    # @fn       def initialize *args {{{
+    # @brief    Default constructor
+    #
+    # @param    [Array]     args      Argument array
+    def initialize *args
+
+      super
+
+      # Store all config paths and relevant filenames (global)
+      @paths                     = OpenStruct.new
+
+      # Level 1
+      @paths.user_home           = Dir.home
+      @paths.fox_home            = options[:'config-path']
+
+      # Level 2
+      @paths.assets              = File.join( @paths.fox_home, 'assets' )
+      @paths.databases           = File.join( @paths.fox_home, 'databases' )
+
+      # Level 3
+      @paths.pomodoro_assets     = File.join( @paths.assets, 'pomodoro' )
+      @paths.coffeeshop_assets   = File.join( @paths.assets, 'coffeeshop' )
+
+      # Sanity check, create if doesn't exist in $HOME
+      @paths.to_h.each do |tag, uri|
+        FileUtils.mkdir_p( uri ) unless( File.exists?( uri ) )
+      end
+
+
+      # Remote Assets URLs
+      @urls                               = OpenStruct.new
+
+      @urls.pomodoro                      = OpenStruct.new
+      @urls.pomodoro.short                = 'https://github.com/rennhak/fox/raw/master/data/pomodoro/pomodoro_5.mp3'
+      @urls.pomodoro.normal               = 'https://github.com/rennhak/fox/raw/master/data/pomodoro/pomodoro_25.mp3'
+
+      @urls.coffeeshop                    = OpenStruct.new
+      @urls.coffeeshop.morning_murmur     = 'https://github.com/rennhak/fox/raw/master/data/coffeeshop/morning_murmur.mp3'
+
+
+      # Assets
+      @assets                             = OpenStruct.new
+
+      @assets.pomodoro                    = OpenStruct.new
+      @assets.pomodoro.short              = File.join( @paths.pomodoro_assets, File.basename( @urls.pomodoro.short ) )
+      @assets.pomodoro.normal             = File.join( @paths.pomodoro_assets, File.basename( @urls.pomodoro.normal ) )
+
+      # Config
+      @config                             = OpenStruct.new
+
+      @config.pomodoro                    = OpenStruct.new
+      @config.pomodoro.default            = :normal
+
+    end # }}}
+
+    Thor::class_option :'config-path', :type => :string, :required => false, :default => "#{Dir.home}/.fox", :desc => 'Change default config path'
+
+  end # of module Configuration
+
+end # of module Mixin
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/fox/interface/thor/mixin/configuration.rb

@@ -15,6 +15,7 @@ module Mixin
     # @param    [Array]     args      Argument array
     def initialize *args
       super
+
       unless File.exist?("~/.fox/config.yaml")
         abort("Could not find configuration file in ~/.fox/config.yaml. Please run 'fox config:generate' to generate it.")
       end

data/lib/fox/interface/thor/mixin/generators/template_loader.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'fox/error/errors'
+# require 'fox/error/errors'
 
 module Mixin
 

data/lib/fox/interface/thor/mixin/network.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+
+
+# System
+require 'open-uri'
+require 'net/http'
+require 'net/ftp'
+require 'uri'
+require 'progressbar'
+require 'date'
+require 'tempfile'
+require 'timeout'
+
+
+
+# @module       module Mixin
+# @brief        Mixin module contains various functions to be used in other components
+module Mixin
+
+  # @module     Network Module
+  # @brief      Module wrapper around network tasks
+  module Network
+
+    # @fn       def initialize *args {{{
+    # @brief    Default constructor
+    #
+    # @param    [Array]     args      Argument array
+    def initialize *args
+      super
+    end # }}}
+
+    # @fn       def online? {{{
+    # @brief    Checks if user is online so we can download assets
+    #
+    # @return   [boolean]     True if online, otherwise false
+    def online?
+
+      begin
+        true if open( "http://www.google.com/", { read_timeout: 5 } )
+      rescue
+        false
+      end
+
+    end # }}}
+
+    # @fn       def download url, target_filename # {{{
+    # @brief    The function get retrieves the given URL content and returns it to the caller
+    #
+    # @param    [String]      url     Requires a string containing a uri which will be downloaded.
+    #
+    # @return   [OpenStruct]          Returns an OpenStruct containing content and many other meta information
+    def download url, target_filename, progress_indicator = true
+
+      # Pre-condition
+      raise ArgumentError, "The function expects a string, but got a (#{url.class.to_s})" unless( url.is_a?(String) )
+
+      # Main
+      content                       = OpenStruct.new
+      request                       = nil
+
+      begin
+        # wait 900s or 15min before timeout
+        status = Timeout::timeout( 900 ) {
+
+          if( progress_indicator )
+
+            # Inspired by http://www.ruby-doc.org/stdlib-1.9.3/libdoc/open-uri/rdoc/OpenURI/OpenRead.html
+            pbar    = nil
+            request = open( url, 
+                        "r", 
+                        :read_timeout => nil,
+                        :content_length_proc => lambda {|t|
+                          if( t && 0 < t )
+                            pbar = ProgressBar.new("...", t)
+                            pbar.file_transfer_mode
+                          end
+                        },
+                        :progress_proc => lambda {|s|
+                          pbar.set s if pbar
+                        }
+                      )
+
+          else
+            request                 = open( url, "r", :read_timeout => nil )
+          end
+
+          STDOUT.puts ""
+
+        } # end of Timeout::timeout
+      rescue Timeout::Error
+        puts 'Time out error - That took too long (>=15min) - fatal abort'
+        exit
+      end
+
+      content.url                   = url
+      content.content               = request.read
+      content.content_type          = request.content_type
+      content.charset               = request.charset
+      content.content_encoding      = request.content_encoding
+      content.last_modified         = request.last_modified
+      content.date                  = DateTime.now
+
+      @logger.message :debug, "Writing content to (file, #{target_filename.to_s})"
+      File.open( target_filename, "w+" ) { |f| f.write( content.content ) }
+
+      # Post-condition
+      raise ArgumentError, "Result should be of type OpenStruct, but is (#{content.class.to_s})" unless( content.is_a?(OpenStruct) )
+
+      [ content, target_filename ]
+    end # }}}
+
+  end # of module Network
+
+end # of module Mixin
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/fox/interface/thor/pomodoro.thor

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+# System
+require 'open-uri'
+
+# Custom includes
+require File.expand_path( File.dirname( __FILE__ ) + '/mixin/logger' )
+require File.expand_path( File.dirname( __FILE__ ) + '/mixin/config' )
+require File.expand_path( File.dirname( __FILE__ ) + '/mixin/network' )
+require File.expand_path( File.dirname( __FILE__ ) + '/mixin/audio' )
+
+
+# @class  Pomodoro command class
+# @brief  Allows you to get more productivity with a ticking egg timer
+class Pomodoro < Thor
+
+  # Include various traits
+  include Thor::Actions
+  include ::Mixin::Logger
+  include ::Mixin::Config
+  include ::Mixin::Network
+  include ::Mixin::Audio
+
+  class_option :stream,   :type => :boolean, :desc => 'Stream from github.com remote', :default => false
+  class_option :download, :type => :boolean, :desc => 'Download from github.com remote', :default => true
+
+  # @fn       def default {{{
+  # @brief    Plays default Pomodoro clock (25 min)
+  desc 'default', 'Plays default Pomodoro clock (25 min) so that you can concentrate'
+  def default
+
+    @logger.message :debug, 'Running sanity check for Pomodoro task'
+    sanity_check
+
+    if( options[:stream] ) 
+      @logger.message :info, 'Streaming from Remote via github.com raw (use CTRL+C to abort)'
+      @logger.message :warning, 'Please do not hammer github.com, download if possible instead'
+
+      play_remote( @urls.pomodoro.send( @config.pomodoro.default ) )
+    else
+      @logger.message :info, 'Playing local file (use CTRL+C to abort)'
+
+      play_local( @assets.pomodoro.send( @config.pomodoro.default ) )
+    end
+
+  end # }}}
+
+  # @fn       def short {{{
+  # @brief    Plays short Pomodoro clock (5 min)
+  desc 'short', 'Plays short Pomodoro clock (5 min) so that you can concentrate'
+  def short
+
+    @logger.message :debug, 'Running sanity check for Pomodoro task'
+    sanity_check
+
+    if( options[:stream] ) 
+      @logger.message :info, 'Streaming from Remote via github.com raw (use CTRL+C to abort)'
+      @logger.message :warning, 'Please do not hammer github.com, download if possible instead'
+
+      play_remote( @urls.pomodoro.short )
+    else
+      @logger.message :info, 'Playing local file (use CTRL+C to abort)'
+
+      play_local( @assets.pomodoro.short )
+    end
+
+  end # }}}
+
+
+  private
+
+  no_tasks do
+
+    # @fn       def sanity_check {{{
+    # @brief    Performs sanity check on online status and required assets
+    def sanity_check
+
+      # Either we stream or we use download / cached version
+      if( options[:stream] )
+        raise ArgumentError, 'Need to have access to Internet to be able to stream' unless( online? )
+      else
+        # Download needed?
+        broken = check_assets
+
+        unless( broken.empty? )
+          raise ArgumentError, "Need to have access to Internet to be able to download missing assets" unless( online? )
+
+          # Download!
+          broken.each do |type|
+            @logger.message :trace, "Downloading missing pomodoro asset (#{type})"
+            download @urls.pomodoro.send( type ), @assets.pomodoro.send( type )
+          end # of broken.each
+
+        end # of unless broken.empty?
+      end # of if( options[:stream] )
+
+    end # of def sanity_check }}}
+
+    # @fn       def check_assets {{{
+    # @brief    Checks local assets for pomodoro task, and if missing returns array with missing keyword
+    #
+    # @return   [Array]     Returns array with missing keywords, e.g. "short", "normal"
+    def check_assets
+      broken = []
+
+      %w[short normal].each do |type|
+        broken << type unless( File.exist?( @assets.pomodoro.send( type ) ) )
+      end # of %w[]
+
+      broken
+    end # def check_assets }}}
+
+  end # of no_tasks do
+
+end # of Class New
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/fox/library/project_builder.rb

@@ -7,30 +7,10 @@ require 'andand'
 require 'fileutils'
 
 
-
+# @fn       class ProjectBuilder
+# @brief    Handles project bootstrapping via convenient Fox DSL
 class ProjectBuilder
 
-    attr_reader :name
-
-  TEMPLATES = {
-      :exe =>
-<<-EOT
-#!/usr/bin/ruby -w
-
-require 'rubygems'
-require 'commandline
-require '%name%'
-
-class %name.capitalize%App < CommandLine::Application
-  def initialize
-  end
-
-  def main
-  end
-end#class %name.capitalize%App
-EOT
-    }
-
   def initialize name
     @name           = name
     @top_level_dir  = Dir.pwd
@@ -41,16 +21,17 @@ EOT
     @cwd            = @project_dir
   end
 
-  def create_project
-    yield
-  end # of def create_project }}}
-
   def self.load project_name, dsl
     proj = new( project_name )
     proj = proj.instance_eval( File.read(dsl), dsl )
     proj
   end # of def self.load }}}
 
+
+  def create_project
+    yield
+  end # of def create_project }}}
+
   def dir dir_name
     old_cwd = @cwd
     @cwd    = File.join(@cwd, dir_name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fox
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Bjoern Rennhak
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: datamapper
   requirement: !ruby/object:Gem::Requirement
@@ -346,6 +360,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: taglib-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Commandline interface and library to the Fox Scientific Paper Suite
 email:
 - bjoern@clothesnetwork.com
@@ -389,6 +417,8 @@ files:
 - lib/fox/interface/thor/default.rb
 - lib/fox/interface/thor/info.thor
 - lib/fox/interface/thor/init.rb
+- lib/fox/interface/thor/mixin/audio.rb
+- lib/fox/interface/thor/mixin/config.rb
 - lib/fox/interface/thor/mixin/config_choice.rb
 - lib/fox/interface/thor/mixin/configuration.rb
 - lib/fox/interface/thor/mixin/database.rb
@@ -402,8 +432,10 @@ files:
 - lib/fox/interface/thor/mixin/history.rb
 - lib/fox/interface/thor/mixin/logger.rb
 - lib/fox/interface/thor/mixin/model.rb
+- lib/fox/interface/thor/mixin/network.rb
 - lib/fox/interface/thor/mixin/shell.rb
 - lib/fox/interface/thor/new.thor
+- lib/fox/interface/thor/pomodoro.thor
 - lib/fox/interface/thor/version.rb
 - lib/fox/library/choice.rb
 - lib/fox/library/logger.rb