motivator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28d28fe55e12ee6b8dde44c811f73475f7841694
+  data.tar.gz: 05c34927fe66fb370b6ef1a07863d69facbe2c1f
+SHA512:
+  metadata.gz: dca6b4b698d905a159e6564e36f2468769ed6fd540b518de7d3256dc55eacf3674b90370deccfe383451426ff827c8ff022130c5eaae0bb00e1b084249d3cfca
+  data.tar.gz: d871ef1de34588e2f31ce1ec32257f0a63b88aa26d28014b6619b0cc76b162ff78030e4db7bcd69cb77bd118b99a365e9fa9e39aed5f67a58a29b00f4419877a

data/bin/motivator

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'motivator'
+require 'yaml'
+require 'colour_output'
+require 'optparse'
+require 'command_parser'
+require 'file_watcher'
+
+# load the quotes from the yaml file
+quotes = YAML.load_file('./lib/quote.yml')
+# initialise the motivation class
+motivator = Motivator.new(quotes['quotes'], ColourOutput.new, FileWatcher.new)
+
+# get arguments from the command line
+parser = CommandParser.new(quotes)
+options = parser.collect(ARGV)
+
+# send the arguments to the motivation object and print the output 
+# to the console
+puts motivator.send(options[:method], options[:arguments])

data/lib/colour_output.rb

@@ -0,0 +1,33 @@
+class ColourOutput
+    attr_accessor :colours, :default
+
+    # initialize and yield self in order to give a hook to modify class
+    def initialize
+        @colours = default_colours
+        @default = "\033[92m"
+
+        yield self if block_given?
+    end
+
+    # default colors hash
+    def default_colours
+        {primary: "\033[95m", blue: "\033[94m", green: "\033[92m", warning: "\033[93m", }
+    end
+
+    # print out a random color
+    def random(string)
+        random_key = @colours.keys.sample
+
+        self.send(random_key, string)
+    end
+
+    # if the method is missing we need to wrap the argument in a 
+    # color from the method call
+    def method_missing(name, *args)
+        if @colours.include? name
+            "#{@colours[name]}#{args[0]}\033[0m"
+        else
+            "#{@default}#{args[0]}\033[0m"
+        end
+    end
+end

data/lib/command_parser.rb

@@ -0,0 +1,70 @@
+require 'optparse'
+
+# wrapper class for options parser
+class CommandParser
+    # pass the config so we can access
+    def initialize config
+        @config = config
+        @options = options
+    end
+
+    # default options 
+    def options
+        { method: nil, arguments: nil}
+    end
+
+    # collect the command arguments via the option parser class
+    def collect(arguments)
+        # build the class options from options parser instance
+        parser = OptionParser.new do |opts|
+            opts.banner = "Options for output grasshopper"
+            opts.separator "\n"
+            opts.separator "Specifics:"
+
+            opts.on('-m [name]', '--motivate [name]', String, "# Output a motivational quote") do |m|
+                @options[:method] = 'motivate'
+                @options[:arguments] = { author: m }
+            end            
+
+            opts.on('-w [glob1,glob2] ', '--watch [glob1,glob2]', Array, '# Watch files & output a message on file/folder change event') do |w|
+                @options[:method] = 'watch'
+                @options[:arguments] = { files: w }
+            end
+
+            opts.on_tail('-h', '--help', '# Output command line help options') do 
+                puts opts
+                exit
+            end
+        end
+
+        # set the options from calling the parser if there are any exceptions
+        # we need to catch them and output the help message
+        begin
+            parser.parse!(arguments)    
+        rescue Exception => e
+            puts parser
+            exit(1)
+        end
+
+        # if no valid methods were set we can't execute and therefore we exit and
+        # put the parser message to the console
+        if @options[:method].nil?            
+            puts parser
+            exit(1)
+        end
+
+        #return the options
+        @options
+    end
+
+    #output a prett list of authors
+    def output_authors
+        authors = []
+
+        @config['quotes'].each do |author|
+            authors << author[0]
+        end
+
+        authors.join(', ')
+    end
+end

data/lib/file_watcher.rb

@@ -0,0 +1,79 @@
+class FileWatcher
+    attr_reader :snapshot, :changed, :event
+
+    def initialize(files = nil, options = {})    
+        @files = files || ['./**/*']
+        @changed = nil
+        @event = nil
+        if not @files.empty?
+            @snapshot = snapshot_filesystem
+        end
+        @options = options
+    end
+
+    def set_files(files)
+        @files = files
+        @snapshot = snapshot_filesystem
+    end
+
+    # take a snapshot of the given files so we can compare at a given date
+    def snapshot_filesystem
+        mtimes = {}
+
+        files = @files.map { |file| Dir[file] }.flatten.uniq
+
+        files.each do |file|
+            if File.exists? file
+                mtimes[file] = File.stat(file).mtime
+            end
+        end
+
+        mtimes
+    end
+
+    # have the given files changed if they have then
+    # set the changed file and return true
+    def files_changed?
+        # initialise variables for the 
+        new_snapshot = snapshot_filesystem
+        has_changed = false
+
+        # take a new snapshot and subtract this from the old snapshot in order to get forward changes
+        # then add the snapshot to the oposite subtraction to get backward changes
+        changes = (@snapshot.to_a - new_snapshot.to_a) + (new_snapshot.to_a - @snapshot.to_a)
+        
+        # determine the event for each change
+        changes.each do |change|
+            if @snapshot.keys.include? change[0]
+                @changed = {change[0] => change[1]}
+                @event = (new_snapshot.keys.include? change[0]) ? :change : :delete
+                has_changed = true
+            else
+                @changed = {change[0] => change[1]}
+                @event = :new
+                has_changed = true
+            end
+        end
+        
+        # lets reset the snapshot so that we don't create a forever loop
+        @snapshot = new_snapshot
+
+        return has_changed
+    end
+
+    # watching the files given in initialize if the files change call the proc
+    def watch(have_changed, waiting = nil)
+        @watching = true
+
+        while @watching
+            if files_changed?
+                @watching = have_changed.call(@changed, @event)
+            end
+
+            sleep(1)
+
+            waiting.call if waiting
+        end
+    end
+
+end

data/lib/motivator.rb

@@ -0,0 +1,47 @@
+class Motivator
+    attr_accessor :quotes
+
+    def initialize(quotes, colourer, watcher)
+        @quotes = quotes
+        @colourer = colourer
+        @watcher = watcher
+    end
+
+    # output a string of motivation to the console prepended by the 
+    # quotes author and coloured with ansi character codes
+    def motivate(opts = {})
+        author = (opts[:author].nil?) ? @quotes.keys.sample : opts[:author]
+
+        readable(author) + @colourer.random(" ~ " + get_quote(author, opts[:id]))
+    end
+
+    # watch the files in the system and call the files changed method as a 
+    # proc when there is an event that we need to hook into
+    def watch(opts)
+        @watcher.set_files(opts[:files]) if opts[:files]
+        @watcher.watch(method(:files_changed))
+    end
+
+    # the callable method which contains the logic once files are changed
+    def files_changed(file, event)
+        puts motivate
+        # return true so that the watch loop keeps running
+        return true
+    end
+
+    # get a quote, either from random or from specified author or index
+    def get_quote(author, index = nil)
+        if index.nil?
+            quote_length = (@quotes[author].length) - 1
+            index = Random.rand(0..quote_length)
+        end
+        
+        @quotes[author][index]
+    end
+
+    # convert from underscores to spaces and capitalise
+    # so the name is readable in the console
+    def readable(string)
+        string.gsub('_', ' ').split.map(&:capitalize).join(' ')
+    end
+end

data/lib/quote.yml

@@ -0,0 +1,42 @@
+#main quotes
+quotes: 
+    bruce_lee: 
+        - "Mistakes are always forgivable, if one has the courage to admit them"
+        - "If you spend too much time thinking about a thing, you'll never get it done"
+        - "A wise man can learn more from a foolish question than a fool can learn from a wise answer"
+    steve_jobs:
+        - "Design is not just what it looks like and feels like. Design is how it works"
+        - "Sometimes when you innovate, you make mistakes. It is best to admit them quickly, and get on with improving your other innovations"
+        - "Innovation distinguishes between a leader and a follower"
+    abraham_licoln:
+        - "Nearly all men can stand adversity, but if you want to test a man's character, give him power"
+        - "Whatever you are, be a good one"
+        - "Always bear in mind that your own resolution to succeed is more important than any other"
+    c_s_lewis: 
+        - "I have found a desire within myself that no experience in this world can satisfy; the most probable explanation is that I was made for another world"
+        - "Friendship is born at that moment when one person says to another: What! You too? I thought I was the only one"
+        - "You are never too old to set another goal or to dream a new dream"
+    thomas_edison:
+        - "I have not failed. I've just found 10,000 ways that won't work"
+        - "Many of life's failures are people who did not realize how close they were to success when they gave up"
+        - "Our greatest weakness lies in giving up. The most certain way to succeed is always to try just one more time"
+    eleanor_roosevelt:
+        - "No one can make you feel inferior without your consent"
+        - "Great minds discuss ideas; average minds discuss events; small minds discuss people"
+        - "The future belongs to those who believe in the beauty of their dreams"
+    mark_twain:
+        - "Don't go around saying the world owes you a living. The world owes you nothing. It was here first"
+        - "I have never let my schooling interfere with my education"
+        - "If you tell the truth, you don't have to remember anything"
+    albert_einstein:
+        - "Two things are infinite: the universe and human stupidity; and I'm not sure about the universe"
+        - "The important thing is not to stop questioning. Curiosity has its own reason for existing"
+        - "Science without religion is lame, religion without science is blind"
+    winston_churchill:
+        - "Success consists of going from failure to failure without loss of enthusiasm"
+        - "If you're going through hell, keep going"
+        - "You have enemies? Good. That means you've stood up for something, sometime in your life"
+    walt_disney: 
+        - "All our dreams can come true, if we have the courage to pursue them"
+        - "It's kind of fun to do the impossible"
+        - "We keep moving forward, opening new doors, and doing new things, because we're curious and curiosity keeps leading us down new paths"

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: motivator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hugo Rut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+description: Quotes to motivate from the command line
+email: hugorut@gmail.com
+executables:
+- motivator
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/colour_output.rb
+- ./lib/command_parser.rb
+- ./lib/file_watcher.rb
+- ./lib/motivator.rb
+- ./lib/quote.yml
+- bin/motivator
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Command line motivator
+test_files: []