kmkr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 609885dbf900a83f2ce045a0022194cf160eb5aa
+  data.tar.gz: c075330efc8c9fe5d7762a105f769848f1502332
+SHA512:
+  metadata.gz: ae94eef6cccf321d4c0a068310465b9e68c4a9a46ef97b65103807926354968a74428f8df2fda951b52ace1409918c35c56387c93db2bfcf0540722ccc2e6d49
+  data.tar.gz: 9f6853bc187b1df4929d37323fa06a0e9f1169e323b9d5883aac3bcd2dc7d8ab61358884a77d550675e8181938c60fc0b1694dddd353528e490f4a887302b606

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+results.html
+pkg
+html
+*.swp
+tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kmkr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    kmkr (0.0.1)
+      methadone (~> 1.9.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.8.1)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      rspec-expectations (>= 2.99)
+    builder (3.2.2)
+    childprocess (0.5.6)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.0)
+    contracts (0.10.1)
+    cucumber (2.0.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.2.0)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.2.0)
+      gherkin (~> 2.12.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    json (1.8.3)
+    methadone (1.9.1)
+      bundler
+    method_source (0.8.2)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.1)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.6)
+  kmkr!
+  pry
+  rake
+  rdoc
+  rspec (~> 3)

data/LICENSE.txt

@@ -0,0 +1,8 @@
+Name: kmkr
+Copyright (c) 2015 Mário Nzualo
+
+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,46 @@
+# kmkr
+kmkr is a CLI to create files prefixed by date (e.g. `20151031.md`). It supports creating files with any file extension,
+date format and a suffix.
+
+## Why
+Because I create notes files everyday with a date prefix and I got tired of manually typing the date myself.
+
+## Installation
+
+    $ gem install kmkr
+
+## Usage
+Specify the extension of the file as an argument.
+
+```bash
+$ kmkr <extension>
+```
+
+### Examples
+```bash
+# Create an .md file with today's date (e.g. 31-10-2015.md)
+$ kmkr md
+
+# Create a .rb file with a different date format (e.g. 20151031.rb)
+$ kmkr rb -f %Y%m%d
+
+# Create a .rb file with a suffix (e.g. 31-10-2015_that_thing.rb)
+$ kmkr rb -s _that_thing
+```
+### Options
+`-f`, `--date-format`
+
+Use a different date format for the filename prefixes. The format directives used are the ones for [Ruby's strftime method](http://ruby-doc.org/core-2.2.2/Time.html#method-i-strftime).
+
+`-d`, `--directory`
+
+Set the location where the file should be saved.
+
+`-s`, `--suffix`
+
+Add a suffix to the filename
+
+You can always get more details using `kmkr -h`.
+
+## License
+MIT (c) Mário Nzualo

data/README.rdoc

@@ -0,0 +1,46 @@
+= kmkr - CLI to create files prefixed by date
+
+Author:: Mário Nzualo (mailto:mario.nzualo at g mail dot com)
+Copyright:: Copyright (c) 2015 Mário Nzualo
+
+License:: mit, see LICENSE.txt
+
+kmkr is a CLI to create files prefixed by date (e.g. `20151031.md`). It supports creating files with any file extension,
+date format and a suffix.
+
+== Why
+Because I create notes files everyday with a date prefix and I got tired of manually typing the date myself.
+
+== Links
+
+* {Source on Github}[https://github.com/marionzualo/kmkr]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+    $ gem install kmkr
+
+== Examples
+
+    # Create an .md file with today's date (e.g. 31-10-2015.md)
+    $ kmkr md
+
+    # Create a .rb file with a different date format (e.g. 20151031.rb)
+    $ kmkr rb -f %Y%m%d
+
+    # Create a .rb file with a suffix (e.g. 31-10-2015_that_thing.rb)
+    $ kmkr rb -s _that_thing
+
+== Options
+`-f`, `--date-format`
+
+Use a different date format for the filename prefixes. The format directives used are the ones for [Ruby's strftime method](http://ruby-doc.org/core-2.2.2/Time.html#method-i-strftime).
+
+`-d`, `--directory`
+
+Set the location where the file should be saved.
+
+`-s`, `--suffix`
+
+Add a suffix to the filename
+
+You can always get more details using `kmkr -h`.

data/Rakefile

@@ -0,0 +1,66 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+begin
+require 'rspec/core/rake_task'
+rescue LoadError
+dump_load_path
+raise
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:spec,:features]
+

data/bin/kmkr

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'kmkr.rb'
+require 'pry'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do |extension|
+    prefix = Kmkr::PrefixDate.new(options[:f]).to_s
+    Kmkr::FileManager.new(prefix, extension, options[:directory], options[:suffix]).create_file
+
+    debug("directory: #{options[:directory]}")
+    debug("date format: #{options[:f]}")
+    debug("prefix: #{prefix}")
+    debug("suffix: #{options[:suffix]}")
+  end
+
+  # supplemental methods here
+
+  # Declare command-line interface here
+
+  description 'Creates files with names prefixed by date'
+
+  # Accept flags via:
+  # on("--flag VAL","Some flag")
+  # options[flag] will contain VAL
+  #
+  # Specify switches via:
+  # on("--[no-]switch","Some switch")
+  #
+  # Or, just call OptionParser methods on opts
+  #
+  options[:directory] = Dir.pwd
+  options[:f] = '%d-%m-%Y'
+  options[:suffix] = ""
+  on('-d DIR', '--directory', 'Set the location where the file should be saved')
+  on('-f DATEFORMAT', '--date-format', 'Use a different date format for the filename prefixes')
+  on('-s SUFFIX', '--suffix', 'Add a suffix to the filename')
+  arg :extension, 'Extension of the file to create'
+
+  # # Make an argument optional
+  # arg :optional_arg, :optional
+
+  version Kmkr::VERSION
+
+  use_log_level_option :toggle_debug_on_signal => 'USR1'
+
+  go!
+end

data/features/kmkr.feature

@@ -0,0 +1,40 @@
+Feature: Create files with a date prefix
+  In order to document things done on a certain day
+  I want a one command way of creating date prefixed files
+  So I don't have to do it myself
+
+  Scenario: Basic UI
+    When I get help for "kmkr"
+    Then the exit status should be 0
+    And the banner should be present
+    And there should be a one line summary of what the app does
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version    |
+      |--directory  |
+      |--date-format|
+      |--suffix     |
+    And the banner should document that this app's arguments are:
+      |extension|which is required|
+
+  Scenario: Create an .md file with today's date
+   When I successfully run `kmkr md`
+   Then a file with a "md" extension and today's date should exist
+
+  Scenario: Do not overwrite file if it already exists
+   Given a file with a "md" extension and today's date exists with content "ola"
+   When I successfully run `kmkr md`
+   Then a file with a "md" extension and today's date should exist
+   And the file with a "md" extension and today's date sould have content "ola"
+
+  Scenario: Create file in specified directry
+    When I successfully run `kmkr md -d that_dir`
+    Then a file with a "md" extension and today's date should exist within "that_dir"
+
+  Scenario: Create a file with today's date and a specified date format
+    When I successfully run `kmkr md -f %Y%m%d`
+    Then a file with a "md" extension and today's date with format "%Y%m%d" should exist
+
+  Scenario: Create a file with a suffix
+    When I successfully run `kmkr md -s _that_thing`
+    Then a file with a "md" extension and today's date with suffix "_that_thing" should exist

data/features/step_definitions/kmkr_steps.rb

@@ -0,0 +1,27 @@
+Then(/^a file with a "([^"]*)" extension and today's date(?: with format "([^"]*)")?(?: with suffix "([^"]*)")? should exist(?: within "([^"]*)")?/) do |extension, date_format, suffix, directory|
+  step "the file named \"#{filename(extension, date_format || "%d-%m-%Y", suffix || "", directory)}\" should exist"
+end
+
+Given(/^a file with a "([^"]*)" extension and today's date exists with content "([^"]*)"$/) do |extension, content|
+  steps %Q{
+   Given a file named "#{filename(extension)}" with:
+     """
+     #{content}
+     """
+  }
+end
+
+Then(/^the file with a "([^"]*)" extension and today's date sould have content "([^"]*)"$/) do |extension, content|
+  step "the file \"#{filename(extension)}\" should contain \"#{content}\""
+end
+
+def filename(extension, date_format = '%d-%m-%Y', suffix = '', directory = nil)
+  today = Date.today.strftime(date_format)
+  filename = "#{today}#{suffix}.#{extension}"
+
+  if directory
+    filename.prepend("#{directory}/")
+  else
+    filename
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,19 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+require 'fileutils'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+
+  FileUtils.rm_rf(Dir.glob('tmp/aruba/*'))
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/kmkr.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kmkr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kmkr"
+  spec.version       = Kmkr::VERSION
+  spec.authors       = ["Mário Nzualo"]
+  spec.email         = ["mario.nzualo@gmail.com"]
+  spec.summary       = %q{CLI to create files prefixed by date}
+  spec.homepage      = "https://github.com/marionzualo/kmkr"
+  spec.license       = "mit"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('aruba')
+  spec.add_development_dependency('pry')
+  spec.add_dependency('methadone', '~> 1.9.1')
+  spec.add_development_dependency('rspec', '~> 3')
+end

data/lib/kmkr/file_manager.rb

@@ -0,0 +1,29 @@
+module Kmkr
+  class FileManager
+    attr_reader :current_dir
+
+    def initialize(prefix, extension, current_dir = Dir.pwd, suffix = "")
+      @current_dir = current_dir
+      @prefix = prefix
+      @extension = extension
+      @suffix = suffix
+    end
+
+    def create_file
+      create_directory unless File.exist?(current_dir)
+      File.new(filename, 'w').close unless File.exist?(filename)
+    end
+
+    private
+
+    attr_reader :prefix, :extension, :suffix
+
+    def filename
+      filename = "#{current_dir}/#{prefix}#{suffix}.#{extension}"
+    end
+
+    def create_directory
+      FileUtils.mkdir_p(current_dir)
+    end
+  end
+end

data/lib/kmkr/prefix_date.rb

@@ -0,0 +1,11 @@
+module Kmkr
+  class PrefixDate
+    def initialize(format = '%d-%m-%Y')
+      @format = format
+    end
+
+    def to_s
+      Date.today.strftime(@format)
+    end
+  end
+end

data/lib/kmkr/version.rb

@@ -0,0 +1,3 @@
+module Kmkr
+  VERSION = "0.0.1"
+end

data/lib/kmkr.rb

@@ -0,0 +1,7 @@
+require 'kmkr/version'
+require 'kmkr/file_manager'
+require 'kmkr/prefix_date'
+
+module Kmkr
+  # Your code goes here...
+end

data/spec/something_spec.rb

@@ -0,0 +1,5 @@
+describe "TestSomething" do
+  it "should be true" do
+    expect(true).to eq(true)
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: kmkr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mário Nzualo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rdoc
+  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: aruba
+  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: pry
+  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: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- mario.nzualo@gmail.com
+executables:
+- kmkr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- bin/kmkr
+- features/kmkr.feature
+- features/step_definitions/kmkr_steps.rb
+- features/support/env.rb
+- kmkr.gemspec
+- lib/kmkr.rb
+- lib/kmkr/file_manager.rb
+- lib/kmkr/prefix_date.rb
+- lib/kmkr/version.rb
+- spec/something_spec.rb
+homepage: https://github.com/marionzualo/kmkr
+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.4.5
+signing_key: 
+specification_version: 4
+summary: CLI to create files prefixed by date
+test_files:
+- features/kmkr.feature
+- features/step_definitions/kmkr_steps.rb
+- features/support/env.rb
+- spec/something_spec.rb