frankly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b231b5fb4caff815c59a89ca54058bd865d6010e
+  data.tar.gz: e46c2c09b1ef059297afdc0b5efe83a6d12e099c
+SHA512:
+  metadata.gz: e27253887dfa90c6e3928213b36acff87678069934e08b3b1a35a1d62acd9eab8aaaf9a8113e0315ae273bdd8de06bbec9dbf03e364591702042f61d9c2650fc
+  data.tar.gz: 279416178b684615ca74217a0b6082d8f562923163311f4ab414f2799e343ba1cf7158dc52ebbc9eedbb373ed7c55b81ef25a98c4c31a150d782bb104f10facd

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ken Rettberg
+
+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,31 @@
+# Frankly
+![Build Status](https://travis-ci.org/kenrett/frankly.svg?branch=master)
+
+An opinionated sinatra skeleton with Rake tasks, rspec, postgres, and more!
+
+## Installation
+
+Type this into the command line:
+
+```
+gem install frankly
+```
+
+## Usage
+
+Simple type `frankly APP_NAME` and frankly will create a sinatra scaffold, git init, and bundle.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kenrett/frankly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format documentation']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "frankly"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/frankly

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+require 'frankly'
+
+begin
+  require 'frankly/cli'
+  Frankly::CLI.start
+rescue Interrupt => e
+  puts "\nQuitting..."
+  exit 1
+rescue SystemExit => e
+  exit e.status
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/frankly.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'frankly/version'
+
+Gem::Specification.new do |spec|
+  spec.name             = "frankly"
+  spec.version          = Frankly::VERSION
+  spec.authors          = ["Ken Rettberg"]
+  spec.email            = %q{kenrettberg@gmail.com}
+  spec.description      = %q{Setup a sinatra skeleton like a boss!}
+  spec.summary          = %q{An opinionated sinatra skeleton with Rake tasks, rspec, postgres, and more!}
+  spec.files            = `git ls-files`.split($/)
+  spec.homepage         = %q{https://github.com/kenrett/frankly}
+  spec.rubygems_version = %q{1.6.2}
+  spec.license          = "MIT"
+  spec.executables      = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files       = spec.files.grep(%r{^(spec)/})
+  spec.require_paths    = ["lib"]
+
+  spec.post_install_message = <<-PIC
+
+              .
+  .---------.'---.
+  '.       :    .'
+    '.  .:::  .' The Chairman
+      '.'::'.'    of the Board
+        '||'       has arrived.
+         ||
+         ||
+         ||
+     ---====---
+       PIC
+
+   spec.add_development_dependency "bundler", "~> 1.3"
+   spec.add_development_dependency "rake", "~> 10.0"
+   spec.add_development_dependency "rspec", "~> 3.6"
+   spec.add_development_dependency "pry-byebug", "~> 3.4"
+
+   spec.add_runtime_dependency 'thor', '~> 0.19.1'
+end

data/lib/frankly/cli.rb

@@ -0,0 +1,66 @@
+require 'pathname'
+require 'fileutils'
+require 'thor'
+require 'thor/group'
+
+module Frankly
+  class CLI < Thor::Group
+    include Thor::Actions
+
+    def self.source_root
+      File.expand_path('../../../templates', __FILE__)
+    end
+
+    desc "Creates a new Sinatra application"
+    argument :name, :type => :string, :desc => "The name of the new application"
+
+    def setup
+      @app_path = name.downcase.gsub(/[^a-z|\-|\_]/, '')
+    end
+
+    def create_app_scaffold
+      empty_directory "#{@app_path}/app"
+      create_file "#{@app_path}/app/models/.gitkeep"
+      create_file "#{@app_path}/app/controllers/.gitkeep"
+      create_file "#{@app_path}/app/views/.gitkeep"
+      create_file "#{@app_path}/app/helpers/.gitkeep"
+      create_file "#{@app_path}/config/.gitkeep"
+      create_file "#{@app_path}/db/migrate/.gitkeep"
+      create_file "#{@app_path}/public/css/.gitkeep"
+      create_file "#{@app_path}/public/js/.gitkeep"
+    end
+
+    def copy_templates
+      copy_file "app/views/layout.erb", "#{@app_path}/app/views/layout.erb"
+      copy_file "config.ru", "#{@app_path}/config.ru"
+      copy_file "Rakefile", "#{@app_path}/Rakefile"
+      copy_file "config/database.rb", "#{@app_path}/config/database.rb"
+      copy_file "config/environment.rb", "#{@app_path}/config/environment.rb"
+      copy_file "db/seeds.rb", "#{@app_path}/db/seeds.rb"
+      copy_file "README.md", "#{@app_path}/README.md"
+      copy_file "Gemfile", "#{@app_path}/Gemfile"
+      copy_file "public/css/application.css", "#{@app_path}/public/css/application.css"
+      copy_file "public/css/normalize.css", "#{@app_path}/public/css/normalize.css"
+      copy_file "public/js/application.js", "#{@app_path}/public/js/application.js"
+      copy_file "public/favicon.ico", "#{@app_path}/public/favicon.ico"
+    end
+
+    def initialize_git_repo
+      puts "about to run git init"
+      inside(@app_path) do
+        run('git init .')
+      end
+    end
+
+    def install_dependencies
+      puts "installing dependencies"
+      inside(@app_path) do
+        run('bundle')
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  cli = Frankly::CLI.start
+end

data/lib/frankly/version.rb

@@ -0,0 +1,3 @@
+module Frankly
+  VERSION = "0.1.0"
+end

data/lib/frankly.rb

@@ -0,0 +1,6 @@
+require "frankly/version"
+require "frankly/cli"
+
+module Frankly
+  # Your code goes here...
+end

data/spec/frankly_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+require "tmpdir"
+require "logger"
+
+describe Frankly do
+  it "has a version number" do
+    expect(Frankly::VERSION).not_to be nil
+  end
+
+  context "when generating a new skeleton" do
+    before(:all) do
+      @templates_path = "#{File.dirname(__FILE__)}/../lib/sinatra_generator/templates"
+      @tmp_dir = Dir.mktmpdir
+      Dir.chdir @tmp_dir
+    end
+
+    it "creates a temporary directory" do
+      expect(@tmp_dir).to_not be nil
+    end
+
+    it "builds a new app" do
+      Frankly::CLI.start ["test_app"]
+
+      expect(File.directory?('test_app')).to be true
+
+      Dir.chdir 'test_app' do
+        expect(File.exist?('config.ru')).to be true
+        expect(File.exist?('Gemfile')).to be true
+        expect(File.exist?('Rakefile')).to be true
+        expect(File.exist?('README.md')).to be true
+        expect(File.directory?('app')).to be true
+        expect(File.directory?('config')).to be true
+        expect(File.directory?('db')).to be true
+        expect(File.directory?('public')).to be true
+      end
+    end
+
+    after(:all) do
+      Dir.chdir('..')
+      FileUtils.rm_rf @tmp_dir
+      expect(File.directory?(@tmp_dir)).to be false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "frankly"
+require "pry-byebug"
+
+#### TODO Figure out how to silence the rubygems (Or prevent it from
+# bundling at all) The solution below only silence the generating
+# files part
+#
+# Borrowed from https://gist.github.com/adamstegman/926858
+#
+# RSpec.configure do |config|
+#   config.before(:all) { silence_output }
+#   config.after(:all) { enable_output }
+# end
+#
+# # Redirects stderr and stdout to /dev/null.
+# def silence_output
+#   @orig_stderr = $stderr
+#   @orig_stdout = $stdout
+#
+#   # redirect stderr and stdout to /dev/null
+#   $stderr = File.new('/dev/null', 'w')
+#   $stdout = File.new('/dev/null', 'w')
+# end
+#
+# # Replace stdout and stderr so anything else is output correctly.
+# def enable_output
+#   $stderr = @orig_stderr
+#   $stdout = @orig_stdout
+#   @orig_stderr = nil
+#   @orig_stdout = nil
+# end

data/templates/Gemfile.tt

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+
+# PostgreSQL driver
+gem 'pg'
+
+# Sinatra driver
+gem 'sinatra', '~> 1.0'
+gem 'sinatra-contrib'
+
+gem 'activesupport', '~>4.2.0'
+gem 'activerecord', '~>4.2.0'
+
+gem 'rake'
+
+gem 'shotgun', '~>0.9.1'
+
+group :test do
+  gem 'shoulda-matchers'
+  gem 'rack-test'
+  gem 'rspec', '~>3.0'
+  gem 'capybara'
+end
+
+group :test, :development do
+  gem 'factory_girl'
+  gem 'faker'
+  gem 'pry-byebug'
+end

data/templates/README.md

@@ -0,0 +1,30 @@
+> **Note**: This branch (master) contains a skeleton without any app code, perfect for creating a _new_ application or challenge. If you're looking for an example app built with this skeleton, take a look at the [example](/../..//tree/example) branch which includes basic CRUD and RSpec tests.
+
+### Purpose
+The Sinatra Skeleton:
+
+1. Provides a foundation for building challenges or creating a new Sinatra application.
+2. Demonstrates a reasonable set of practices around building Sinatra applications.
+3. Eases the transition to Rails for Dev Bootcamp students
+
+### Quickstart
+
+1.  `bundle install`
+2.  `shotgun config.ru`
+
+As needed, create models & migrations with the `rake` tasks:
+
+```
+rake generate:migration  # Create an empty migration in db/migrate, e.g., rake generate:migration NAME=create_tasks
+rake generate:model      # Create an empty model in app/models, e.g., rake generate:model NAME=User
+```
+
+### Contributing
+
+We would love for you to help make the skeleton more awesome, There are three ways to contribute:
+
+1. Ask for a bug fix or enhancement!
+2. Submit a pull request for a bug fix or enhancement!
+3. Code review an open pull request!
+
+Be prepared to give and receive specific, actionable, and kind feedback!

data/templates/Rakefile

@@ -0,0 +1,150 @@
+require 'rake'
+
+require ::File.expand_path('../config/environment', __FILE__)
+
+# Include all of ActiveSupport's core class extensions, e.g., String#camelize
+require 'active_support/core_ext'
+
+namespace :generate do
+  desc "Create an empty model in app/models, e.g., rake generate:model NAME=User"
+  task :model do
+    unless ENV.has_key?('NAME')
+      raise "Must specificy model name, e.g., rake generate:model NAME=User"
+    end
+
+    model_name     = ENV['NAME'].camelize
+    model_filename = ENV['NAME'].underscore + '.rb'
+    model_path = APP_ROOT.join('app', 'models', model_filename)
+
+    if File.exist?(model_path)
+      raise "ERROR: Model file '#{model_path}' already exists"
+    end
+
+    puts "Creating #{model_path}"
+    File.open(model_path, 'w+') do |f|
+      f.write(<<-EOF.strip_heredoc)
+        class #{model_name} < ActiveRecord::Base
+          # Remember to create a migration!
+        end
+      EOF
+    end
+  end
+
+  desc "Create an empty migration in db/migrate, e.g., rake generate:migration NAME=create_tasks"
+  task :migration do
+    unless ENV.has_key?('NAME')
+      raise "Must specificy migration name, e.g., rake generate:migration NAME=create_tasks"
+    end
+
+    name     = ENV['NAME'].camelize
+    filename = "%s_%s.rb" % [Time.now.strftime('%Y%m%d%H%M%S'), ENV['NAME'].underscore]
+    path     = APP_ROOT.join('db', 'migrate', filename)
+
+    if File.exist?(path)
+      raise "ERROR: File '#{path}' already exists"
+    end
+
+    puts "Creating #{path}"
+    File.open(path, 'w+') do |f|
+      f.write(<<-EOF.strip_heredoc)
+        class #{name} < ActiveRecord::Migration
+          def change
+          end
+        end
+      EOF
+    end
+  end
+
+  desc "Create an empty model spec in spec, e.g., rake generate:spec NAME=user"
+  task :spec do
+    unless ENV.has_key?('NAME')
+      raise "Must specificy migration name, e.g., rake generate:spec NAME=user"
+    end
+
+    name     = ENV['NAME'].camelize
+    filename = "%s_spec.rb" % ENV['NAME'].underscore
+    path     = APP_ROOT.join('spec', filename)
+
+    if File.exist?(path)
+      raise "ERROR: File '#{path}' already exists"
+    end
+
+    puts "Creating #{path}"
+    File.open(path, 'w+') do |f|
+      f.write(<<-EOF.strip_heredoc)
+        require 'spec_helper'
+        describe #{name} do
+          pending "add some examples to (or delete) #{__FILE__}"
+        end
+      EOF
+    end
+  end
+
+end
+
+namespace :db do
+  desc "Drop, create, and migrate the database"
+  task :reset => [:drop, :create, :migrate]
+
+  desc "Create the databases at #{DB_NAME}"
+  task :create do
+    puts "Creating development and test databases if they don't exist..."
+    system("createdb #{APP_NAME}_development && createdb #{APP_NAME}_test")
+  end
+
+  desc "Drop the database at #{DB_NAME}"
+  task :drop do
+    puts "Dropping development and test databases..."
+    system("dropdb #{APP_NAME}_development && dropdb #{APP_NAME}_test")
+  end
+
+  desc "Migrate the database (options: VERSION=x, VERBOSE=false, SCOPE=blog)."
+  task :migrate do
+    ActiveRecord::Migrator.migrations_paths << File.dirname(__FILE__) + 'db/migrate'
+    ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+    ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, ENV["VERSION"] ? ENV["VERSION"].to_i : nil) do |migration|
+      ENV["SCOPE"].blank? || (ENV["SCOPE"] == migration.scope)
+    end
+  end
+
+  desc "rollback your migration--use STEP=number to step back multiple times"
+  task :rollback do
+    step = (ENV['STEP'] || 1).to_i
+    ActiveRecord::Migrator.rollback('db/migrate', step)
+    Rake::Task['db:version'].invoke if Rake::Task['db:version']
+  end
+
+  desc "Populate the database with dummy data by running db/seeds.rb"
+  task :seed do
+    require APP_ROOT.join('db', 'seeds.rb')
+  end
+
+  desc "Returns the current schema version number"
+  task :version do
+    puts "Current version: #{ActiveRecord::Migrator.current_version}"
+  end
+
+  namespace :test do
+    desc "Migrate test database"
+    task :prepare do
+      system "rake db:migrate RACK_ENV=test"
+    end
+  end
+end
+
+desc 'Start IRB with application environment loaded'
+task "console" do
+  exec "pry -r./config/environment"
+end
+
+
+# In a production environment like Heroku, RSpec might not
+# be available.  To handle this, rescue the LoadError.
+# https://devcenter.heroku.com/articles/getting-started-with-ruby-o#runtime-dependencies-on-development-test-gems
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default  => :spec

data/templates/app/helpers/README.md

@@ -0,0 +1,32 @@
+# HELPERS
+
+## Basics
+
+Helpers are methods that are defined in a central place but which can be used
+inside of your view templates.  An example of a helper is shown in
+`app/views/index.erb` inside where we use the `em` helper.
+
+## Adding helpers
+
+Add helpers here inside of *.rb files inside this directory e.g.:
+`app/helpers/formatting.rb`.
+
+Inside this file define your helpers like:
+
+```
+helpers do
+  def em(text)
+    "<em>#{text}</em>"
+  end
+end
+```
+
+## Reloading
+
+After you create new files containing helpers, you must restart the web server
+so that your changes are reloaded into the running web server process.  This is
+because helper files are read *only once* at web-server *startup* time.  Also,
+if you add a new helper or alter its implementation, you *also* must restart it
+so that "sourced" (i.e. read in) anew.  Other web frameworks do not require
+this restart e.g. Rails but in this starter kit  you're best not "bubbling out"
+helpers until your implementation has "gelled."

data/templates/app/models/README.md

@@ -0,0 +1,5 @@
+Add your ActiveRecord models here.
+
+You can create them by being in the application root directory and running:
+
+`rake generate:model NAME=User`