one_pager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2697b75174b2fbf8afe31b60ccff236e721acf1b7cb23763e1b0ec0256075b9
+  data.tar.gz: ead23530734c57f232850b8769ca0d1382ab6aef3d5a7a60b09b945a3f2b3fb1
+SHA512:
+  metadata.gz: 854f309491e44a1fe52a3569561d84b207fdcd79b61e7c4d579ef2856e1b46420f4423e348a14e0a695e39a7656aababb99566b73a56938b06ad6d571378073e
+  data.tar.gz: 1c5a8f9ee4ffb235ed762e24943c818d8bfd82bdd566b26594c4157a085532dcc2a899dc0255245013b7bd4987f06ab811fcd8cc4eea05866712b6937fe3eb4d

data/.one-pager/config.yml

@@ -0,0 +1,3 @@
+{
+  "template": "standard"
+}

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    one_pager (0.0.1)
+      gli (= 2.18.0)
+      tilt (= 2.0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.14.8)
+      childprocess (>= 0.6.3, < 1.1.0)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    backports (3.11.4)
+    builder (3.2.3)
+    childprocess (1.0.1)
+      rake (< 13.0)
+    coderay (1.1.2)
+    contracts (0.16.0)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    ffi (1.10.0)
+    gherkin (5.1.0)
+    gli (2.18.0)
+    method_source (0.9.2)
+    multi_json (1.13.1)
+    multi_test (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.2)
+    rdoc (6.1.1)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+    tilt (2.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  one_pager!
+  pry
+  rake
+  rdoc
+
+BUNDLED WITH
+   2.0.1

data/README.rdoc

@@ -0,0 +1,13 @@
+= one_pager
+
+Everyone loves version control yeah? People also love to keep our business proposals organized.
+Why not have both? Using `one-pager` you can easily generate new one-pagers anywhere in your system.
+Simply run `$ one-pager init` in any directory and it will create a `docs/one-pagers` folder if it does
+not exist, as well as a `.one-pager` file if it already doesn't exist (this file is used for setting configurations).
+
+From here you can run commands such as `one-pager create "Allow users to purchase in DogeCoin"` and it will
+generate a markdown file (`doc/one-pagers/allow_users_to_purchase_in_dogecoin.md`), which will be pre-populated with
+with your one-pager template. This can be configured via the `.one-pager` file.
+
+:include:one_pager.rdoc
+

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('one_pager.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/bin/one_pager

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'one_pager'
+
+DEFAULT_CONFIGURATION_TEMPLATE =<<-TEMPLATE
+{
+  "template": "standard"
+}
+TEMPLATE
+
+class App
+  extend GLI::App
+
+  program_desc 'Describe your application here'
+
+  version OnePager::VERSION
+
+  subcommand_option_handling :normal
+  arguments :strict
+
+  desc 'Describe some switch here'
+  switch [:s,:switch]
+
+  desc 'Describe some flag here'
+  default_value 'the default'
+  arg_name 'The name of the argument'
+  flag [:f,:flagname]
+
+  desc 'Describe init here'
+  arg_name 'Describe arguments to init here'
+  command :init do |c|
+    c.desc 'Describe a switch to init'
+    c.switch :s
+
+    c.desc 'Describe a flag to init'
+    c.default_value 'default'
+    c.flag :f
+    c.action do |global_options,options,args|
+
+      system 'mkdir', '-p', 'docs/one-pagers'
+
+      File.open('.one-pager/config.json', 'w') { |file| file.write(DEFAULT_CONFIGURATION_TEMPLATE) }
+
+      puts "One Pagers Directory and Configuration created!"
+    end
+  end
+
+  desc 'Describe add here'
+  arg_name 'Describe arguments to add here'
+  command :add do |c|
+
+    c.flag [:od, :output_dir]
+    c.flag [:op, :output_path]
+
+    c.action do |global_options,options,args|
+      filename = "#{args[0].downcase.gsub(" ", "_")}.md"
+      template = if File.exists?(".one-pager.json")
+                   JSON.read(".one-pager.json")["template"]
+                 elsif options[:template]
+                   options[:template]
+                 else
+                  "standard"
+                 end
+      markdown_contents = OnePager::Generator.genrate_one_pager(template, args[0])
+      output_path = if options[:output_path]
+                      options[:output_path]
+                    elsif options[:output_dir]
+                      system 'mkdir', '-p', "docs/one-pagers/#{options[:output_dir]}"
+                      "docs/one-pagers/#{options[:output_dir]}/#{filename}"
+                    else
+                      "docs/one-pagers/#{filename}"
+                    end
+      File.open(output_path, "w") { |file| file.write(markdown_contents)}
+    end
+  end
+
+  desc 'Describe display here'
+  arg_name 'Describe arguments to display here'
+  command :display do |c|
+    c.action do |global_options,options,args|
+      puts "display command ran"
+    end
+  end
+
+  desc 'Describe remove here'
+  arg_name 'Describe arguments to remove here'
+  command :remove do |c|
+    c.action do |global_options,options,args|
+      puts "remove command ran"
+    end
+  end
+
+  pre do |global,command,options,args|
+    # Pre logic here
+    # Return true to proceed; false to abort and not call the
+    # chosen command
+    # Use skips_pre before a command to skip this block
+    # on that command only
+    true
+  end
+
+  post do |global,command,options,args|
+    # Post logic here
+    # Use skips_post before a command to skip this
+    # block on that command only
+  end
+
+  on_error do |exception|
+    # Error logic here
+    # return false to skip default error handling
+    true
+  end
+end
+
+exit App.run(ARGV)

data/docs/one-pagers/allow_for_displaying_markdown_files_via_cli.md

@@ -0,0 +1,13 @@
+# Proposal: Allow for displaying markdown files via CLI
+
+## Purpose
+Help make one pagers in a given directory more visible to any user
+
+## Execution Plan
+Write out business logic for printing contents
+
+## Expected Outcomes
+People can easily print the contents of a given one-pager proposal
+
+## Anticipated Setbacks/Deficiencies
+I go down a rabbit hole trying to color code things

data/features/one_pager.feature

@@ -0,0 +1,8 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "one_pager"
+    Then the exit status should be 0

data/features/step_definitions/one_pager_steps.rb

@@ -0,0 +1,6 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+# Add more step definitions here

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+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
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/one_pager/generator.rb

@@ -0,0 +1,9 @@
+module OnePager::Generator
+
+  def self.genrate_one_pager(template, title)
+    file_path = File.join(File.dirname(__FILE__), "templates/#{template}.md.erb")
+    template = Tilt::ERBTemplate.new(file_path)
+    output = template.render(nil, title: title)
+  end
+
+end

data/lib/one_pager/templates/standard.md.erb

@@ -0,0 +1,9 @@
+# Proposal: <%= title %>
+
+## Purpose
+
+## Execution Plan
+
+## Expected Outcomes
+
+## Anticipated Setbacks/Deficiencies

data/lib/one_pager/version.rb

@@ -0,0 +1,3 @@
+module OnePager
+  VERSION = '0.0.1'
+end

data/lib/one_pager.rb

@@ -0,0 +1,6 @@
+require 'one_pager/version.rb'
+require 'one_pager/generator.rb'
+require 'tilt/erb'
+require 'json'
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file

data/one_pager.gemspec

@@ -0,0 +1,34 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','one_pager','version.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'one_pager'
+  s.version = OnePager::VERSION
+  s.author = 'Michael Poage'
+  s.email = 'poage.michael.cu@gmail.com'
+  s.homepage = 'https://github.com/RubyBrewsday'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Easily manage one-pager documentation via the command line. #spicy'
+  s.description = %q{
+    Everyone loves version control yeah? People also love to keep our business proposals organized.
+    Why not have both? Using `one-pager` you can easily generate new one-pagers anywhere in your system.
+    Simply run `$ one-pager init` in any directory and it will create a `docs/one-pagers` folder if it does
+    not exist, as well as a `.one-pager` file if it already doesn't exist (this file is used for setting configurations).
+
+    From here you can run commands such as `one-pager create "Allow users to purchase in DogeCoin"` and it will
+    generate a markdown file (`doc/one-pagers/allow_users_to_purchase_in_dogecoin.md`), which will be pre-populated with
+    with your one-pager template. This can be configured via the `.one-pager` file.
+  }
+  s.files = `git ls-files`.split("
+")
+  s.require_paths << 'lib'
+  s.extra_rdoc_files = ['README.rdoc','one_pager.rdoc']
+  s.rdoc_options << '--title' << 'one_pager' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'one_pager'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('aruba')
+  s.add_runtime_dependency('gli','2.18.0')
+  s.add_runtime_dependency('tilt', '2.0.9')
+end

data/one_pager.rdoc

@@ -0,0 +1,5 @@
+= one_pager
+
+Generate this with
+    one_pager _doc
+After you have described your command line interface

data/test/default_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class DefaultTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: one_pager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Poage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-07 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.9
+description: "\n    Everyone loves version control yeah? People also love to keep
+  our business proposals organized.\n    Why not have both? Using `one-pager` you
+  can easily generate new one-pagers anywhere in your system.\n    Simply run `$ one-pager
+  init` in any directory and it will create a `docs/one-pagers` folder if it does\n
+  \   not exist, as well as a `.one-pager` file if it already doesn't exist (this
+  file is used for setting configurations).\n\n    From here you can run commands
+  such as `one-pager create \"Allow users to purchase in DogeCoin\"` and it will\n
+  \   generate a markdown file (`doc/one-pagers/allow_users_to_purchase_in_dogecoin.md`),
+  which will be pre-populated with\n    with your one-pager template. This can be
+  configured via the `.one-pager` file.\n  "
+email: poage.michael.cu@gmail.com
+executables:
+- one_pager
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- one_pager.rdoc
+files:
+- ".gitignore"
+- ".one-pager/config.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- README.rdoc
+- Rakefile
+- bin/one_pager
+- docs/one-pagers/allow_for_displaying_markdown_files_via_cli.md
+- features/one_pager.feature
+- features/step_definitions/one_pager_steps.rb
+- features/support/env.rb
+- lib/one_pager.rb
+- lib/one_pager/generator.rb
+- lib/one_pager/templates/standard.md.erb
+- lib/one_pager/version.rb
+- one_pager.gemspec
+- one_pager.rdoc
+- test/default_test.rb
+- test/test_helper.rb
+homepage: https://github.com/RubyBrewsday
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- one_pager
+- "--main"
+- README.rdoc
+- "-ri"
+require_paths:
+- lib
+- 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.7.3
+signing_key: 
+specification_version: 4
+summary: 'Easily manage one-pager documentation via the command line. #spicy'
+test_files: []