codestrap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ade3b755f5973545b219689e0842be8ed6ca922
+  data.tar.gz: 5249299dab56defeba0fa2c075321033986d8bf5
+SHA512:
+  metadata.gz: caf4f4aeeef6684135046cdaa417036de74832cd476ebb849a6066dc77c074fa37683ed3e01a59ce3a4c966ddde93729f944b18914b65aaccb45c696ebc2066c
+  data.tar.gz: b6ca59e18da972da5a30795b7f7d9afd147c6eb7cdc5cec3775f515dffe225f2ba8c571e06c9c974032ca2f9f71b2287f983038db31c8d6f2b72a32dbf64be55

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Vagrantfile
+.ruby-gemset
+.ruby-version
+/.vagrant/
+atlassian-ide-plugin.xml
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.5
+script: rake features

data/.yardopts

@@ -0,0 +1,3 @@
+--title 'CodeStrap Documentation'
+--markup markdown
+--markup-provider redcarpet

data/BOILERPLATE.md

@@ -0,0 +1,151 @@
+# Template Setup
+
+## 1. Content directory
+```
+$HOME/.codestrap/content
+```
+
+The content directory contains all file and project templates.
+ 
+### Individual text file templates
+
+Individual text templates as files ending in .erb (EG script.erb). These are Embedded Ruby files. Objects in these files are generated from files contained in the *objects/* directory.
+
+  * Each file ending in .erb has a one to one relationship with a generated command.
+  * Generated commands for individual text files begin with *stub* and end with the same name as the file under *content* minus the .erb postfix.
+
+### Project templates
+
+Sub directories form project templates (EG content/puppetmodule).
+
+  * Each sub-directory has a one to one relationship with a generated command.
+  * Generated commands for projects begin with *strap* and end with the same name as the sub-directory.
+
+#### ERB templates and project context
+
+ERB Files in a project template do not end in ".erb". Instead the files have a *modeline* entry "strap:erb" or "stub:erb" (within the first 10 lines), to indicate an ERB template.
+```erb
+#!/bin/sh
+# strap:erb
+# Author: <%= author.name %>
+# Email: <%= author.email %>
+```
+
+Note: Modelines are removed from the generated boilerplate
+
+#### Directory text interpolation
+
+Directory names can contain variables/objects which are interpolated with the idiom ":strap:object.text:" or ":stub:object.text:"
+```
+content/PROJECT/:strap:project.name:/myfile.txt
+content/PROJECT/:stub:project.name:/myfile.txt
+```
+
+## 2. Generated commands directory
+```
+$HOME/.codestrap/bin
+```
+
+Contains generated commands (symlinks). Generated commands have a one to one relationship with a content directory file/sub-directory.
+
+  * Generated commands corresponding to text file templates begin with *stub* followed by *textfile* (minus the .erb) in the content directory.
+  * Generated commands corresponding to project templates begin with *strap* followed by *dir* in the content directory.
+
+## 3. Variable/Object definition files directory
+```
+$HOME/.codestrap/objects
+```
+
+Contains *.json, *.yaml or executable files which output JSON. Objects are available in YAML format.
+
+### YAML Objects
+
+A file named *"company.yaml"* with content
+```yaml
+name: ACME Corp.
+email: email@address.com
+url: "http://www.company.com"
+```
+
+Creates an object "company" with interfaces "company.name", "company.email" and "company.url". Each interface corresponds to the relevant *"company.yaml"* file entry.
+
+The "company" object is then available to all template files.
+
+*Example ERB*
+```erb
+#!/bin/sh
+
+mail -s "Order product" <%= company.email %> <<EOF
+Hello <%= company.name %>,
+
+I just ordered more product from <%= company.url %>.
+EOF
+```
+
+### JSON Objects
+
+A file named *"socialmedia.json"* with content
+```json
+{
+  "twitter": "supercoder",
+  "facebook": "http://www.facebook.com/supercoder"
+}
+```
+
+Creates an object "socialmedia" with interfaces "socialmedia.twitter", "socialmedia.facebook" interfaces containg the relevant values from *socialmedia.json*
+
+*Example use in a ERB file*
+```erb
+#!/bin/sh
+
+echo "Posting to <%= socialmedia.facebook %> and sending a tweet to <%= socialmedia.twitter %>
+```
+
+### Executable file Objects
+
+Executable file objects are similar to JSON Objects except the JSON string is parsed directly from script standard output (STDOUT).
+
+A file named *"system.sh"* with content
+```sh
+#!/bin/sh
+cat <<EOF
+{
+  "hostname": "$(hostname)",
+  "uname": "$(uname -a)",
+  "uptime": "$(uptime)"
+}
+EOF
+```
+
+Creates an object "system" (All postfixes are stripped out EG .sh .py .rb), with interfaces "system.hostname", "system.uname" and "system.uptime" containing values of the same unix command.
+
+*Example use in a ERB file*
+```erb
+#!/bin/sh
+
+echo "The Uptime of host <%= system.hostname %> is <%= system.uptime %>."
+echo "The kernel version is <%= system.uname %>
+```
+
+### Default Objects
+
+Codestrap also creates objects internally for use in templates.
+
+*project*
+```erb
+<%= project.module %> - Name of the strap$MODULE or stub$MODULE used.
+<%= project.name %> - Name of directory or file output.
+```
+
+*datetime*
+This is the DateTime object used in Ruby created using "DateTime.now()". You can use any methods available to this object in your code but to save time here are some useful ones.
+
+*Example use in a ERB file*
+```erb
+<%= datetime.strftime('%c') %> - Sample "Wed Jun 29 23:20:49 2016"        - Date and Time (%a %b %e %T %Y)
+<%= datetime.strftime('%D') %> - Sample "06/29/16"                        - Date (%m/%d/%y)
+<%= datetime.strftime('%F') %> - Sample "2016-06-29"                      - The ISO 8601 date format (%Y-%m-%d)
+<%= datetime.strftime('%R') %> - Sample "23:20"                           - 24-hour time (%H:%M)
+<%= datetime.strftime('%T') %> - Sample "23:20:49"                        - 24-hour time (%H:%M:%S)
+<%= datetime.strftime('%+') %> - Sample "Wed Jun 29 23:20:49 +10:00 2016" - date(1) (%a %b %e %H:%M:%S %Z %Y)
+```

data/CODESTRAPFILE.md

@@ -0,0 +1,28 @@
+# Configuration
+
+The default configuration file for Codestrap is located at
+
+```
+$HOME/.codestrap/Codestrapfile
+```
+
+This can be overriden using the $CODESTRAPFILE environment variable 
+
+```bash
+export CODESTRAPFILE='/usr/local/codestrap/Codestrapfile'
+```
+
+Available settings
+
+```ruby
+Codestrapfile.config do |conf|
+  # Base directory or list of base directories that contain "object" and "content" sub directories
+  # Defaults to $HOME/.codestrap
+  #conf.local.base   = [ '/home/user/.codestrap', '/usr/local/codestrap' ]
+  #conf.local.base = '/home/user/.codestrap'
+  
+  # Ignore paths or list of paths to ignore
+  #conf.local.ignore = [ '.git', '.svn' ]
+  #conf.local.ignore = '.git'
+end
+```

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codestrap.gemspec
+gemspec
+
+gem 'omnibus-software', git: 'https://github.com/chef/omnibus-software.git'

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2014 Dexter Plameras
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,69 @@
+# CodeStrap
+
+[![Build Status](https://travis-ci.org/dexterp/codestrap.svg?branch=master)](https://travis-ci.org/dexterp/codestrap)
+[![Dependency Status](https://gemnasium.com/dexterp/codestrap.png)](https://gemnasium.com/dexterp/codestrap)
+[![Inline docs](http://inch-ci.org/github/dexterp/codestrap.svg)](http://inch-ci.org/github/dexterp/codestrap)
+
+CodeStrap is a simple command line project code generator. It provides an easy way to create custom boilerplate for new projects and individual text files, and a very easy way to access that boilerplate.
+
+It is written specifically for ease of use on the command line.
+
+## Quickstart
+
+### 1. Download and install using the package installer
+
+At this stage only Linux and OSX are supported.
+
+[PACKAGES](https://github.com/dexterp/codestrap/releases)
+ 
+### 2. Clone the sample templates to your home directory
+
+```bash
+git clone http://github.com/dexterp/codestrap-samples.git $HOME/.codestrap
+```
+
+### 3. Add CodeStrap files to your path
+
+```bash
+echo 'export PATH=$HOME/.codestrap/bin:$PATH' >> $HOME/.profile
+```
+
+### 4. Scan available templates and generate commands (sym links)
+
+```bash
+# List templates
+ls $HOME/.codestrap/content
+
+# Generate links
+strap -g
+
+# List generated commands
+ls $HOME/.codestrap/bin
+```
+
+### 5. Create files and projects from boilerplate
+
+```bash
+# Text file boilerplate
+stubrubyscript myscript.rb
+stubperlscript myscript.pl
+```
+
+```
+# Project boilerplate
+strappuppetmodule mypuppetmodule
+straprubygem mygem
+```
+
+## Boilerplate Setup
+
+For template setups for both projects and individual files see ...
+
+[BOILERPLATE](BOILERPLATE.md)
+
+## Configuration File
+
+Codestrap uses "Codestrapfile" as a configuration file. For details see.
+
+[CODESTRAPFILE](CODESTRAPFILE.md)
+

data/Rakefile

@@ -0,0 +1,51 @@
+ROOT          = File.dirname(File.expand_path(__FILE__))
+FEATURES_PATH = File.join(ROOT, 'features')
+LIB_PATH      = File.join(ROOT, 'lib')
+TMP_PATH      = File.join(ROOT, 'tmp')
+TMP_FILES     = Rake::FileList.new(File.join(ROOT, 'tmp','*'))
+PACKAGES      = Rake::FileList.new(File.join(ROOT, 'pkg', '*'))
+DOCS          = Rake::FileList.new(File.join(ROOT, 'doc', '*'))
+$LOAD_PATH.unshift(LIB_PATH)
+require 'codestrap'
+require 'codestrap/version'
+require 'bundler/gem_tasks'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rake'
+require 'yard'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "#{FEATURES_PATH} -r #{FEATURES_PATH}/step_definitions -r #{FEATURES_PATH}/support --format pretty"
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = %w[ lib/**/*.rb ]
+end
+
+desc 'Clean files'
+task :clean do
+  clean = []
+  clean += TMP_FILES
+  clean += PACKAGES
+  clean += DOCS
+  clean.each do |file|
+    rm_rf file
+  end
+end
+
+desc 'Uninstall'
+task :uninstall do
+  sh 'gem uninstall codestrap -x'
+end
+
+desc 'Reinstall'
+task :reinstall do
+  Rake::Task['uninstall'].invoke
+  Rake::Task['install'].invoke
+end
+
+desc 'Package using omnibus'
+task :package do
+  Rake::Task['build'].invoke
+  sh 'omnibus build codestrap'
+end

data/bin/strap

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'codestrap'
+
+args = [$0] + ARGV
+
+Codestrap::Core.new(args).execute!
+

data/bin/upstrap

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'codestrap'
+require 'codestrap/server/rest'
+
+exit(0)
+
+Codestrap::Server::Rest.run!

data/codestrap.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codestrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'codestrap'
+  spec.version       = Codestrap::VERSION
+  spec.authors       = ['Dexter Plameras']
+  spec.email         = ['dpgrps@gmail.com']
+  spec.summary       = %q{File codestrap and boilerplate command line tool.}
+  spec.description   = <<EOF
+Codestrap is a file codestrap and boilerplate project tool. It is run from the command line
+and has been designed to make use of the CLIs autocomplete functionality available
+on supported operating systems shells.
+EOF
+  spec.homepage      = ''
+  spec.license       = 'Apache'
+
+  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_runtime_dependency 'sinatra', '~> 1.4.5'
+  spec.add_runtime_dependency 'ptools'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'shotgun'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'mocha'
+end

data/config/projects/codestrap.rb

@@ -0,0 +1,22 @@
+#
+# Copyright 2016 Dexter Plameras
+#
+# All Rights Reserved.
+#
+require File.absolute_path(File.join(File.dirname(__FILE__),'..','..','lib','codestrap','version'))
+
+name 'codestrap'
+maintainer 'Dexter Plameras'
+homepage 'https://github.com/dexterp/codestrap'
+
+# Defaults to C:/codestrap on Windows
+# and /opt/codestrap on all other platforms
+install_dir "#{default_root}/#{name}"
+
+build_version Codestrap::VERSION
+build_iteration 1
+
+dependency 'codestrap'
+
+exclude "**/.git"
+exclude "**/bundler/git"