evertils 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bf3d2b3c26ba0ece79f8aa12e697f5cd7edae75
-  data.tar.gz: 2fe5780fb6e21b93c3afb34f8dbd6f934f812f1c
+  metadata.gz: 9e842768fbe2f278375d2237fd4f574b5384bc0e
+  data.tar.gz: 2206bb78084adf5ea0f47d5efdb70be1e8ca808f
 SHA512:
-  metadata.gz: 57861f7047caa63344d7a55f0f0a0f99a9d67d4d2f84463034a68ddf0633c09f4ec9b8aa7478ea0c28fb0057cdca6ee9fd38b581045e525bdc91c992bce83b36
-  data.tar.gz: c7ffdb0d40287f62da1ad3291b882e29af084b4276de62a8c1200e56a3e28e12b6b0b408d96d7dfdaa164becbc828895cd48a134d30123b1cdf7ba0e2b6b5465
+  metadata.gz: 6219f5fcce8ada651fac7abcfa8b7f2e194bb3946e1045600bb74729d5f745473075ab14c46122d74cc9c34617725f4eb2490cac2e1b1dca222f251e95ea1943
+  data.tar.gz: c5dc1a67ae390280ddf15ce6709735bf8e1ea698c187589ace2d0e6791a4c3fdcc0c565be78cb020588033e62c7645ee35eea6b909b4ddb4fb7e1e7714f6b66c

data/bin/evertils

@@ -1,46 +1,15 @@
 #!/usr/bin/env ruby
 
-require 'date'
-require 'time'
-require 'json'
-require 'optparse'
-require 'rbconfig'
-require 'evernote-thrift'
-require 'net/http'
-require 'uri'
-require 'fileutils'
-require 'cgi'
-require 'notifaction'
-require 'digest/md5'
-require 'mime/types'
-require 'evertils/common'
-require 'yaml'
-require 'nokogiri'
+# fix load path
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-# include required files
-require_relative '../lib/kernel'
-require_relative '../lib/version'
-require_relative '../lib/type'
-require_relative '../lib/helpers/time'
-require_relative '../lib/helpers/results'
-require_relative '../lib/helpers/api-enml-handler'
-require_relative '../lib/log'
-require_relative '../lib/config'
-require_relative '../lib/request'
-require_relative '../lib/utils'
-require_relative '../lib/logs'
-require_relative '../lib/command'
-require_relative '../lib/controller'
-require_relative '../lib/router'
-require_relative '../lib/helpers/formatting'
-require_relative '../lib/helpers/evernote-enml'
-require_relative '../lib/helper'
+require 'evertils'
 
 # Modify configuration options here
-$config = Evertils::Cfg.new
-# Bootstrap!
-$config.bootstrap!
+app = Evertils::Cfg.new
+app.bootstrap!
 
 # Config file located, route the request
-req = Evertils::Router.new
+req = Evertils::Router.new(app)
 req.route

data/evertils.gemspec

@@ -1,7 +1,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require './lib/version'
+require 'evertils/version'
 
 Gem::Specification.new do |s|
   s.name                  = 'evertils'

data/lib/evertils/config.rb

@@ -0,0 +1,55 @@
+module Evertils
+  class Cfg
+    # Perform first run tasks and create or read config file values
+    def bootstrap!
+      populate_config
+
+      return if valid_config?
+
+      # no config file found, lets create one using the firstrun controller
+      require 'client/controller/firstrun'
+
+      controller = Evertils::Controller::Firstrun.new
+      controller.default
+
+      populate_config
+    end
+
+    # Returns a hash of all module constants and their values
+    def options
+      keys = Evertils.constants.select { |name| constant?(name) }
+      hash = {}
+
+      keys.each { |key| hash[key] = Evertils.const_get(key) }
+      hash
+    end
+
+    # Populates the internal hash which stores any values set in the config file
+    def populate_config
+      file = File.expand_path("~/.evertils/config.yml")
+      fmt = Evertils::Helper.load('Formatting')
+
+      @yml = fmt.symbolize(::YAML.load_file(file))
+      self
+    end
+
+    # Get a specific value from the config file data
+    # Params:
+    # +name+:: String/symbol key value
+    def get(name)
+      @yml[name.to_sym]
+    end
+
+    private
+
+    # Check if configuration data exists
+    def valid_config?
+      !@yml.nil?
+    end
+
+    # Checks if string is a constant
+    def constant?(name)
+      name == name.upcase
+    end
+  end
+end

data/lib/evertils/controller.rb

@@ -0,0 +1,69 @@
+module Evertils
+  module Controller
+    class Base
+      # Access the configuration object instance externally
+      attr_accessor :config
+      # Access the request object instance externally
+      attr_accessor :request
+
+      # Exit code to indicate everything is ok!
+      OK = 0
+      # Exit code to indicate a force quit (exit) call, meaning the program
+      # quit with an error
+      QUIT = 1
+      # Exit code to indicate that the program exited with a non-zero exit code,
+      # but not one that resulted in a force quit
+      QUIT_SOFT = 2
+
+      # Setup internal variables that will be used in subclasses
+      # Params:
+      # +config+:: Instance of Evertils::Cfg to enable access to config file
+      # +request+:: Instance of Evertils::Request, enables access to request
+      #             parameters
+      def initialize(config, request)
+        @config = config
+        @request = request
+
+        pre_exec
+      end
+
+      # Perform pre-run tasks
+      def pre_exec
+        @format = Evertils::Helper.load('Formatting')
+      end
+
+      # Handle the request
+      def exec
+        if @request.param.nil?
+          send(@method.to_sym)
+        else
+          send(@method.to_sym, @request.flags.first)
+        end
+      end
+
+      # Perform post-run cleanup tasks, such as deleting old logs
+      def post_exec
+      end
+
+      # Determines if the command can execute
+      # Params:
+      # +command+:: Symbol containing the command we want to execute
+      def can_exec?(command)
+        # no command was passed, check if controller has a default method
+        if command.nil? && respond_to?(:default)
+          @method = :default
+        elsif respond_to? command
+          # check the controller for the requested method
+          @method = command
+        else
+          raise NoMethodError, "Invalid method: #{command}"
+        end
+      end
+
+      # Default method called by exec if no argument is passed
+      def sample
+        Notify.warning("Method not implemented")
+      end
+    end
+  end
+end

data/lib/{controllers → evertils/controllers}/convert.rb

@@ -37,7 +37,7 @@ module Evertils
 
           metadata.each_pair do |note_guid, note_content|
             # convert it here!
-            puts note_content
+            Notify.spit(note_content)
           end
         else
           Notify.error("Could not pull data for notebook #{@notebook}")

data/lib/evertils/controllers/firstrun.rb

@@ -0,0 +1,24 @@
+module Evertils
+  module Controller
+    class Firstrun < Controller::Base
+      # Create the configuration file if it does not exist
+      def default
+        if File.exist?("#{Dir.home}/.evertils/config.yml")
+          Notify.error('Configuration already exists, this is not the first run!  Exiting.', show_time: false)
+        end
+
+        File.open("#{Dir.home}/.evertils/config.yml", "w") do |f|
+          f.write <<-'CONTENTS'
+  templates:
+  Monthly:
+      "templates/monthly.enml"
+  Daily:
+      "templates/daily.enml"
+
+  provider: Evernote
+          CONTENTS
+        end
+      end
+    end
+  end
+end

data/lib/{controllers → evertils/controllers}/generate.rb

@@ -7,51 +7,35 @@ require_relative '../types/monthly'
 module Evertils
   module Controller
     class Generate < Controller::Base
-      attr_accessor :force, :start, :name
-
-      def pre_exec
-        @methods_require_internet.push(:daily, :weekly, :monthly, :mts)
-
-        OptionParser.new do |opt|
-          opt.banner = "#{Evertils::PACKAGE_NAME} generate timeframe [...-flags]"
-
-          opt.on("-n", "--name=NAME", "A name to pass to the script (not all commands support this flag)") do |name|
-            @name = name
-          end
-        end.parse!
-
-        super
-      end
-
       # generate daily notes
       def daily
-        note = Type::Daily.new
+        note = Type::Daily.new(@config)
         note.create
       end
 
       # generate weekly notes
       def weekly
-        note = Type::Weekly.new
+        note = Type::Weekly.new(@config)
         note.create
       end
 
       # generate monthly notes
       def monthly
-        note = Type::Monthly.new
+        note = Type::Monthly.new(@config)
         note.create
       end
 
       # generate monthly task summary templates
-      def mts
-        Notify.error('Name argument is required', {}) if @name.nil?
+      def mts(arg)
+        Notify.error('Name argument is required', {}) if arg.nil?
 
-        note = Type::MonthlyTaskSummary.new(@name)
+        note = Type::MonthlyTaskSummary.new(@config, arg[1])
         note.create
       end
 
       # generate priority queue notes
       def pq
-        note = Type::PriorityQueue.new
+        note = Type::PriorityQueue.new(@config)
         note.create
       end
 
@@ -61,16 +45,16 @@ module Evertils
       #  - weekly (if today is Monday and there isn't a weekly log already)
       #  - monthly (if today is the 1st and there isn't a monthly log already)
       def morning
-        pq = Type::PriorityQueue.new
+        pq = Type::PriorityQueue.new(@config)
         pq.create
 
-        daily = Type::Daily.new
+        daily = Type::Daily.new(@config)
         daily.create
 
-        weekly = Type::Weekly.new
+        weekly = Type::Weekly.new(@config)
         weekly.create if weekly.should_create?
 
-        monthly = Type::Monthly.new
+        monthly = Type::Monthly.new(@config)
         monthly.create if monthly.should_create?
       end
     end

data/lib/{controllers → evertils/controllers}/get.rb

@@ -6,7 +6,7 @@ module Evertils
       def pre_exec
         # command flag parser
         OptionParser.new do |opt|
-          opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
+          opt.banner = "evertils new note [...-flags]"
 
           opt.on("-t", "--title=TITLE", "Set a custom title") do |title|
             @title = title
@@ -35,7 +35,7 @@ module Evertils
             Notify.info("Printing list of notes")
 
             metadata.notes.each do |note|
-              puts note.title
+              Notify.spit note.title
             end
           else
             Notify.error("Could not pull data for notebook #{$request.custom[0]}", {})
@@ -46,7 +46,7 @@ module Evertils
       end
 
       def info
-        $config.options.each_pair do |key, value|
+        @config.options.each_pair do |key, value|
           Notify.spit("#{key}: #{value}")
         end
       end

data/lib/{controllers → evertils/controllers}/status.rb

@@ -3,8 +3,8 @@ module Evertils
     class Status < Controller::Base
 
       def default
-        $config.options.each_pair do |key, value|
-          puts "#{key}: #{value}"
+        @config.options.each_pair do |key, value|
+          Notify.spit "#{key}: #{value}"
         end
       end
 

data/lib/{helper.rb → evertils/helper.rb}

@@ -1,18 +1,18 @@
 module Evertils
   module Helper
-    def self.load(klass, args = nil)
+    def self.load(klass, *args)
       begin
         klass_instance = Evertils::Helper.const_get(klass)
 
         if klass_instance
-          if args.nil?
+          if args.empty?
             klass_instance.new
           else
             klass_instance.new(args)
           end
         end
       rescue => e
-        Notify.error(e.message)
+        Notify.error("#{e}\n#{e.backtrace.join("\n")}", show_time: false)
       end
     end
   end

data/lib/{helpers → evertils/helpers}/api-enml-handler.rb

@@ -3,8 +3,8 @@ module Evertils
     class ApiEnmlHandler
       #
       # @since 0.3.7
-      def initialize(enml = nil)
-        convert_to_xml(enml) if enml
+      def initialize(config = nil)
+        @config = config
         self
       end
 
@@ -26,14 +26,7 @@ module Evertils
 
         # remove <br> tags
         note_xml.search('br').each(&:remove)
-
-        enml = note_xml.inner_html.to_s
-
-        # append custom sections to the end of the content if they exist
-        return enml if $config.custom_sections.nil?
-
-        enml += to_enml($config.custom_sections[NOTEBOOK_PRIORITY_QUEUE])
-        enml
+        note_xml.inner_html.to_s
       end
 
       #

data/lib/{helpers → evertils/helpers}/evernote-markdown.rb

@@ -32,7 +32,7 @@ module Evertils
         @indent = 0
         @errors = []
       end
-      
+
       # Invokes the HTML parsing by using a string. Returns the markdown code in @output.
       # To garantuee well-formed xml for REXML a <root> element will be added, but has no effect.
       # After parsing all elements, the 'reference style'-links will be inserted.
@@ -45,7 +45,7 @@ module Evertils
         insert_links()
         @output
       end
-      
+
       # Parsing an element and its children (recursive) and writing its markdown code to @output
       # 1. do indent for nested list items
       # 2. add the markdown opening tag for this element
@@ -58,18 +58,18 @@ module Evertils
         @output << indent() if name.eql?(:li)
         # 2.
         @output << opening(element, parent)
-        
+
         # 3a.
         if (element.has_text? and element.children.size < 2)
           @output << text_node(element, parent)
         end
-        
+
         # 3b.
         if element.has_elements?
           element.children.each do |child|
             # increase indent if nested list
             @indent += 1 if element.name=~/(ul|ol)/ and parent.eql?(:li)
-            
+
             if child.node_type.eql?(:element)
               parse_element(child, element.name.to_sym)
             else
@@ -79,12 +79,12 @@ module Evertils
                 @output << child.to_s
               end
             end
-            
+
             # decrease indent if end of nested list
             @indent -= 1 if element.name=~/(ul|ol)/ and parent.eql?(:li)
           end
         end
-        
+
         # 4.
         @output << ending(element, parent)
       end
@@ -124,7 +124,7 @@ module Evertils
             ""
         end
       end
-      
+
       # Returns the closing markdown tag, like opening()
       def ending(type, parent)
         case type.name.to_sym
@@ -160,7 +160,7 @@ module Evertils
             ""
         end
       end
-      
+
       # Perform indent: two space, @indent times - quite simple! :)
       def indent
         str = ""
@@ -169,7 +169,7 @@ module Evertils
         end
         str
       end
-      
+
       # Return the content of element, which should be just text.
       # If its a code block to indent of 4 spaces.
       # For block quotation add a leading '>'
@@ -182,7 +182,7 @@ module Evertils
           element.text
         end
       end
-      
+
       # Insert the mentioned reference style links.
       def insert_links
         @output << "\n"
@@ -190,14 +190,14 @@ module Evertils
           @output << "  [#{index+1}]: #{@links[index]}\n"
         end
       end
-      
+
       # Print out all errors, that occured and have been written to @errors.
       def print_errors
         @errors.each do |error|
-          puts error
+          Notify.error(error)
         end
       end
-      
+
       # Perform a benchmark on a given string n-times.
       def speed_benchmark(string, n)
         initialize()

data/lib/{helpers → evertils/helpers}/formatting.rb

@@ -29,9 +29,9 @@ module Evertils
 
           IO.readlines(load_template(type), :encoding => 'UTF-8').join("").delete!("\n")
         rescue Errno::ENOENT => e
-          Notify.error(e.message)
+          Notify.error("#{e}\n#{e.backtrace.join("\n")}", show_time: false)
         rescue ArgumentError => e
-          Notify.error(e.message)
+          Notify.error("#{e}\n#{e.backtrace.join("\n")}", show_time: false)
         end
       end
 
@@ -51,9 +51,22 @@ module Evertils
         }
       end
 
-      # format command as required by this model
-      def command
-        $request.command.capitalize
+      # Recursively symbolize keys in a hash
+      # Params:
+      # +h+:: The hash you want to symbolize
+      def symbolize(h)
+        case h
+        when Hash
+          Hash[
+            h.map do |k, v|
+              [k.respond_to?(:to_sym) ? k.to_sym : k, symbolize(v)]
+            end
+          ]
+        when Enumerable
+          h.map { |v| symbolize(v) }
+        else
+          h
+        end
       end
 
       private
@@ -61,34 +74,23 @@ module Evertils
       #
       # @since 0.3.1
       def load_template(type)
-        template_type_map = {
-          :Daily => "daily",
-          :Weekly => "weekly",
-          :Monthly => "monthly",
-          :"Monthly Task Summaries" => "mts",
-          :"Priority Queue" => "pq"
-        }
-
-        default = "#{Evertils::TEMPLATE_DIR}#{template_type_map[type]}.enml"
+        file_name = type.to_s.downcase.gsub(/\s/, '-')
+        installed_dir = Gem::Specification.find_by_name('evertils').gem_dir
+        local_installed_dir = "#{Dir.home}/.evertils/templates/"
+        template_file = "#{installed_dir}/#{file_name}.enml"
 
-        return default if $config.custom_templates.nil?
+        if Dir.exist? local_installed_dir
+          template_file = "#{local_installed_dir}#{file_name}.enml"
 
-        rval = default
-        tmpl = $config.custom_templates[type]
-
-        if !tmpl.nil?
-          rval = $config.custom_path
-
-          if tmpl.include?('~')
-            rval += tmpl.gsub!(/~/, Dir.home)
-          else
-            rval += tmpl
+          # local config dir exists but the requested template does not, use
+          # the default template for this type
+          unless File.exist? template_file
+            template_file = "#{installed_dir}/#{file_name}.enml"
           end
         end
 
-        rval
+        template_file
       end
-
     end
   end
 end

data/lib/evertils/request.rb

@@ -0,0 +1,31 @@
+module Evertils
+  class Request
+    # Access controller variable property externally
+    attr_reader :controller
+    # Access command variable property externally
+    attr_reader :command
+    # Access custom variable property externally
+    attr_reader :custom
+    # Access flags variable property externally
+    attr_reader :flags
+    # Access raw_flags variable property externally
+    attr_reader :raw_flags
+    # Access param variable property externally
+    attr_reader :param
+
+    # Create the request object, parse ARGV for values
+    def initialize
+      raise ArgumentError, "ARGV is empty" if ARGV.empty?
+
+      @flags = ARGV.select { |f| f.start_with?('-') }.map { |f| f.split('=').map(&:to_sym) } || []
+      @raw_flags = ARGV.select { |f| f.start_with?('-') } || []
+      @controller = ARGV[0].to_sym unless ARGV[0].start_with?('-')
+      @command = ARGV[1].to_sym unless ARGV[1].nil?
+
+      return unless ARGV.size > 2
+
+      @custom = ARGV[2..ARGV.size].reject { |p| p.start_with?('-') }.map(&:to_sym) || []
+      @param = ARGV[2]
+    end
+  end
+end

data/lib/evertils/router.rb

@@ -0,0 +1,56 @@
+module Evertils
+  class Router
+    # Create the router object
+    # Params:
+    # +config_instance+:: An instance of Evertils::Cfg
+    def initialize(config_instance)
+      @config = config_instance
+    end
+
+    # Prepare for routing
+    def pre_exec
+      @request = Request.new
+
+      begin
+        # include the controller
+        require "evertils/controllers/#{@request.controller}"
+        # include helpers
+        require "evertils/helpers/#{@request.controller}" if File.exist? "evertils/helpers/#{@request.controller}"
+      rescue LoadError
+        Notify.error("Controller not found: #{@request.controller}")
+      end
+    end
+
+    # Perform command routing
+    def route
+      pre_exec
+
+      # Create object context and pass it the required command line arguments
+      begin
+        unless @request.controller.nil?
+          controller = Evertils::Controller.const_get @request.controller.capitalize
+
+          # create an instance of the requested controller
+          context = controller.new(@config, @request)
+
+          if context.can_exec? @request.command
+            # Set things up
+            context.pre_exec
+
+            # Run the requested action
+            context.exec
+
+            # Run cleanup commands
+            context.post_exec
+          end
+        end
+      rescue NoMethodError => e
+        Notify.error("#{e}\n#{e.backtrace.join("\n")}", show_time: false)
+      rescue RuntimeError => e
+        Notify.error("#{e}\n#{e.backtrace.join("\n")}", show_time: false)
+      rescue NameError => e
+        Notify.error("#{e}\n#{e.backtrace.join("\n")}", show_time: false)
+      end
+    end
+  end
+end