shlog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88d4f7c4779c663d196b5ab7dad8c4f61942a366
+  data.tar.gz: a1613136dd2cf415dc562fe2d8f8b08d1f997c1a
+SHA512:
+  metadata.gz: 9805e79a7e801bc11c2afb795bc48a982de83e050832680c325059ed3c43cfc390d575e6510bac8521eb1c953139949081e1f7535ba314fe617e5ea895625919
+  data.tar.gz: 67e49a17d773f53d81ceb8669ab378a1d0a6d18f0e6b8bbc7bad938ea567cc474e126df5252f16c9b4f1bb5043d3c7d3757ae21123ed6de29ea99136d2fa2547

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aziz Light
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+shlog
+=====
+
+A wrapper around [lumberjack](https://github.com/bdurand/lumberjack) to make logging on the command line easier.
+
+Usage
+-----
+
+From the command-line:
+
+```
+> shlog help
+```
+
+Or from any shell script:
+
+```sh
+shlog log "Ruby is Awesome!"
+```
+
+Configuration
+-------------
+
+TODO: Document this!
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/shlog

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/shlog"
+
+Signal.trap("SIGINT") do
+  puts "Terminating"
+  exit 1
+end
+
+shlog = Shlog::CLI
+
+exit shlog.run(ARGV)

data/lib/shlog.rb

@@ -0,0 +1,18 @@
+# Require dev shit
+if ENV["DEV_MODE"] == "debug"
+  require "ap" rescue nil
+end
+
+# Require Standard Library shit
+require "psych"
+require "erb"
+
+# Require gems shit
+require "gli"
+require "rainbow/ext/string"
+require "lumberjack"
+
+# Require personal shit
+require_relative "./shlog/version"
+require_relative "./shlog/basic_cli"
+require_relative "./shlog/cli"

data/lib/shlog/basic_cli.rb

@@ -0,0 +1,100 @@
+module Shlog
+  module BasicCLI
+    def self.included(mod)
+      mod.class_eval do
+        extend GLI::App
+
+        const_set(:CONFIG_FILE_NAME, "shlogrc")
+
+        const_set(:CONFIG_FILES, [
+          File.expand_path(File.join(File.dirname(File.realpath(__FILE__)), "..", "..", const_get(:CONFIG_FILE_NAME))),
+          File.join(ENV["HOME"], ".#{const_get(:CONFIG_FILE_NAME)}"),
+          File.join(Dir.getwd, ".#{const_get(:CONFIG_FILE_NAME)}")
+        ])
+
+        class << self
+          attr_accessor :cli_command
+
+          def cli_defaults
+            @cli_defaults ||= Hash.new
+          end
+
+          def cli_defaults=(value)
+            @cli_defaults = value
+          end
+
+          def config_to_options_for(command, config)
+            self.cli_command ||= command
+
+            setup_cli!
+
+            config.each do |k, v|
+              base_option_name = base_option_name_for(k, @cli_options[:list])
+
+              @cli_options[:list][base_option_name].each do |f|
+                @cli_options[:values][f] = v
+              end
+            end
+
+            @cli_options.fetch(:values)
+          end
+
+          def setup_cli!
+            raise RuntimeError, "Command not set!" unless cli_command
+
+            unless @cli_options
+              @cli_options = { list: Hash.new, values: Hash.new }
+
+              flags_array = cli_command.flags.map(&:last).map { |f| [f.name, f.aliases].flatten }
+              flags_array.each do |o|
+                @cli_options[:list][o.first.to_sym] = [o.map(&:to_sym), o.map(&:to_s)].flatten.compact unless @cli_options.fetch(:list).has_key?(o.first.to_sym)
+
+                o.each do |oo|
+                  @cli_options[:values][oo.to_sym] = nil unless @cli_options.fetch(:values).has_key?(oo.to_sym)
+                  @cli_options[:values][oo.to_s]   = nil unless @cli_options.fetch(:values).has_key?(oo.to_s)
+                end
+              end
+
+              switches_array = cli_command.switches.map(&:last).map { |s| [s.name, s.aliases].flatten.compact }
+              switches_array.each do |o|
+                @cli_options[:list][o.first.to_sym] = [o.map(&:to_sym), o.map(&:to_s)].flatten.compact unless @cli_options.fetch(:list).has_key?(o.first.to_sym)
+
+                o.each do |oo|
+                  @cli_options[:values][oo.to_sym] = false unless @cli_options.fetch(:values).has_key?(oo.to_sym)
+                  @cli_options[:values][oo.to_s]   = false unless @cli_options.fetch(:values).has_key?(oo.to_s)
+                end
+              end
+            end
+          end
+
+          def base_option_name_for(option, option_list)
+            name = nil
+
+            option_list.each do |n, o|
+              if o.include?(option)
+                name = n
+                break
+              end
+            end
+
+            name
+          end
+        end
+
+        private
+
+        def self.set_default_options!
+          config_file = const_get(:CONFIG_FILES).first
+
+          if File.exists?(config_file) && File.readable?(config_file)
+            config = Psych.load(ERB.new(IO.read(config_file)).result)
+          else
+            config = {}
+          end
+
+          self.cli_defaults = config["commands"]
+        end
+      end
+    end
+  end
+end

data/lib/shlog/cli.rb

@@ -0,0 +1,52 @@
+module Shlog
+  class CLI
+    include Shlog::BasicCLI
+
+    program_desc  "Command-line logging made easy"
+    version       Shlog::VERSION
+
+    desc "Path to the config file to use"
+    arg_name "FILE"
+    flag [:config]
+
+    set_default_options!
+    commands_from File.expand_path(File.join(File.dirname(File.realpath(__FILE__)), "commands"))
+
+    pre do |global, command, options, args|
+      config_files = CONFIG_FILES
+      default_config_file = config_files.shift
+
+      if global[:config]
+        # If a config file is explicitely specified, it MUST exist!
+        unless File.exists?(global[:config])
+          raise RuntimeError, "Unable to find config file: #{global[:config]}"
+        end
+
+        config_files << global[:config]
+      end
+
+      config_files.each do |cf|
+        begin
+          next unless File.exists?(cf) && File.readable?(cf)
+
+          config = Psych.load(ERB.new(IO.read(cf)).result)
+          options.merge!(config_to_options_for(command, config["commands"][command.name.to_sym]))
+
+          # TODO: Add a flag to skip other config files, maybe?
+        rescue => e
+          raise RuntimeError, "Unable to load config from '#{cf}': #{e.message}"
+        end
+      end
+
+      options.merge!(options[:cli])
+
+      true
+    end
+
+    on_error do |exception|
+      puts exception.message.color(:red)
+
+      false
+    end
+  end
+end

data/lib/shlog/commands/log.rb

@@ -0,0 +1,84 @@
+module Shlog
+  class CLI
+    desc "Add a log entry"
+    arg_name "MESSAGE"
+    command :log do |c|
+      c.desc "Name of the program that is logging the message"
+      c.arg_name "PROGNAME"
+      c.flag [:p, :progname], must_match: /\A[a-zA-Z0-9_.-]+\Z/
+
+      c.desc "Level of severity"
+      c.default_value self.cli_defaults[:log][:level]
+      c.arg_name "LEVEL"
+      c.flag [:l, :level], must_match: /\A[a-zA-Z0-9]+\Z/
+
+      c.desc "Path to the log file"
+      c.long_desc <<-DESC
+          Directory of the log file (without the name).
+          The directory does not have to exist.
+      DESC
+      c.default_value self.cli_defaults[:log][:directory]
+      c.arg_name "DIRECTORY"
+      c.flag [:d, :directory]
+
+      c.desc "Name of the log file"
+      c.long_desc <<-DESC
+          Name of the log file (without the path).
+          The file does not have to exist and the
+          `.log` extension is not required.
+      DESC
+      c.default_value self.cli_defaults[:log][:file]
+      c.arg_name "FILE"
+      c.flag [:f, :file]
+
+      c.desc "The maximum size of the log file"
+      c.long_desc <<-DESC
+          This size represents the number of log entries in the log file.
+          If the size of the log file has reached the maximum value, it will
+          be "archived" and a new log file will be created. The new log entry
+          will then go in the new log file.
+      DESC
+      c.default_value self.cli_defaults[:log][:"max-size"]
+      c.arg_name "SIZE"
+      c.flag [:s, :"max-size"], must_match: /\A[0-9]+\Z/
+
+      c.desc "Enable colors"
+      c.switch :colors, default: false
+
+      c.desc "Vebose mode"
+      c.switch :v, :verbose, default: false
+
+      c.desc "Get the path to the log file"
+      c.switch :g, :"get-logfile", default: false, negatable: false
+
+      c.action do |global_options, options, args|
+        file = File.join(File.expand_path(options[:directory]), options[:file])
+
+        if options[:"get-logfile"]
+          # NOTE: All the options are ignored when the '--get-logfile' options is passed
+
+          puts file
+        else
+          if args.empty?
+            raise ArgumentError, "Cannot add a log entry without a message"
+          end
+
+          template = lambda do |e|
+            t  = "[#{e.time} #{e.severity_label}"
+            t << " (#{e.progname})" if e.progname
+            t << "] #{e.message}"
+            t
+          end
+
+          logger = Lumberjack::Logger.new(file, time_format: "%m/%d/%Y %H:%M:%S", template: template, max_size: options[:"max-size"])
+          logger.progname = options[:progname]
+          logger.send(options[:level].to_s.downcase, args.join(" "))
+
+          if options[:verbose]
+            puts "Log entry added".color(:green)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shlog/version.rb

@@ -0,0 +1,4 @@
+module Shlog
+  version_file = File.expand_path("../../VERSION", File.dirname(File.realpath(__FILE__)))
+  VERSION = File.read(version_file).freeze
+end

data/shlog.gemspec

@@ -0,0 +1,25 @@
+require_relative "./lib/shlog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shlog"
+  spec.version       = Shlog::VERSION
+  spec.authors       = ["Aziz Light"]
+  spec.email         = ["aziz@azizlight.me"]
+  spec.description   = %q{A wrapper around lumberjack (https://github.com/bdurand/lumberjack) to make logging on the command line easier.}
+  spec.summary       = %q{Command-line logging made easy}
+  spec.homepage      = "https://github.com/AzizLight/shlog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "awesome_print"
+
+  spec.add_runtime_dependency "gli_aziz_light"
+  spec.add_runtime_dependency "rainbow"
+  spec.add_runtime_dependency "lumberjack"
+end

data/shlogrc

@@ -0,0 +1,8 @@
+---
+commands:
+  :log:
+    :directory: <%= File.join(ENV["HOME"], ".logs") %>
+    :file: <%= "#{ENV["USER"]}.log" %>
+    :level: "INFO"
+    :"max-size": 5000
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: shlog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aziz Light
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli_aziz_light
+  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: rainbow
+  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: lumberjack
+  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: A wrapper around lumberjack (https://github.com/bdurand/lumberjack) to
+  make logging on the command line easier.
+email:
+- aziz@azizlight.me
+executables:
+- shlog
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/shlog
+- lib/shlog.rb
+- lib/shlog/basic_cli.rb
+- lib/shlog/cli.rb
+- lib/shlog/commands/log.rb
+- lib/shlog/version.rb
+- shlog.gemspec
+- shlogrc
+homepage: https://github.com/AzizLight/shlog
+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 logging made easy
+test_files: []