minimum_viable_product 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a679d084c129a1fd35b87fa3a70a2b321f3fd8
-  data.tar.gz: e8a1093ce6915d717b5cc91df630dc3f7f57986d
+  metadata.gz: df89a6a293780e6776262278120582f42a3e1dba
+  data.tar.gz: 7d87f208787ae7500c8121ed59130f4f4f89555b
 SHA512:
-  metadata.gz: df034dfd5b9de87ce81b334d16f95aef20ad71cbec2e5156b29df0016c3f6ef4913b6a8943e17c94ea0b2cdffb744f01d12a6128e853ee288270526d2020209f
-  data.tar.gz: 331687913d98446f49dce742d03e4df4f43f3a6a8736aa508779ac52c38dab943a1b79061baa3c317e2cb938a0a2b99498a4750392d99461d8807985a042569f
+  metadata.gz: c33be1e81405732ae0204c2f31a9e11af811e737cc487b7e7c40813f78a202d87730e53b72bb061c3823554ffa8870d0b10bb00cf0889cc2215d46407afd1b92
+  data.tar.gz: b9803cf4e42cb0f10f0b8e7938f7c84253b36342e986f6537898039f81e2615b2477ac457db8d4be921ab1e0b9c16113b74da6e1459cfb2489e6da1eaccda566

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,85 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.4)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.6)
+      oauth2
+    hashie (3.4.6)
+    highline (1.7.8)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.6)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    public_suffix (2.0.4)
+    rack (1.6.5)
+    rake (12.0.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Ian Hunter
+
+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,133 @@
+# Installation
+
+Install the mvp gem:
+
+```
+gem install minimum_viable_product
+```
+
+Then setup your project:
+
+```
+mvp new PROJECT
+```
+
+# Setup
+
+## `.env`
+
+Set your `.env` file up with your own variables
+
+```
+ROLLBAR_CLIENT_ACCESS_TOKEN=
+ROLLBAR_SERVER_ACCESS_TOKEN=
+SEGMENT_WRITE_KEY=
+SLACK_WEBHOOK_URL=
+SLACK_POST_USERNAME=
+FACEBOOK_TRACKING_ID=
+HOST_DOMAIN=localhost
+HOST_PORT=3000
+HOST_PROTOCOL=http
+GOOGLE_ANALYTICS_ID=
+HOTJAR_ID=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_S3_BUCKET=
+SPOOF_IP=true
+```
+
+## Heroku
+
+To setup deployment for heroku, first create the project:
+
+```
+heroku create PROJECT
+```
+
+You're probably going to want Database backups.  This will let you use `rake db:import`
+
+```
+heroku pg:backups capture
+```
+
+You're also going to need to setup the buildpacks
+
+```
+heroku buildpacks:set heroku/ruby
+heroku buildpacks:add --index 1 heroku/nodejs
+```
+
+Make sure to turn off npm cacheing (since we're loading MVP from a repo)
+
+```
+heroku config:set NODE_MODULES_CACHE=false
+```
+
+Add a scheduled task to update your sitemaps:
+
+```
+heroku addons:create scheduler:standard
+heroku addons:open scheduler
+```
+
+Add the following task: `rake sitemap:worker`.  Your choice on the frequency but I usually use `daily`
+
+# SEO
+
+## Meta Properties
+
+All meta fields are controlled via the `page` object.  Set attributes on this in order to get meta properties populated.  This is best done at the controller level.
+
+### Available Properties
+
+|Property|Description|Inheritance|
+|---|---|---|
+|`page.title`|   |   |
+|`page.description`|   |   |
+|`page.author`|   |   |
+|`page.og_url`|   |   |
+|`page.og_type`|   |   |
+|`page.og_title`|   |`page.title`|
+|`page.og_description`|   |`page.description`|
+|`page.og_image`|   |   |
+|`page.twitter_card`|   |   |   |
+
+## Sitemaps
+
+### Setup
+
+Edit `config/sitemap.rb` with your own custom routes.
+
+### Updating
+
+Run `sitemap:refresh` in production to update Bing/Google with changes to the sitemap.
+
+Put this in a `cron` task or in Heroku Scheduler.
+
+# Helpers
+
+## Geolocation
+
+By default, Geolocation of the session will automatically happen.
+
+You can access the session's geolocation in `request.location`.
+
+To test geolocation locally, set `SPOOF_IP=true` in your `.env`.
+
+For more info see [Geocoder](https://github.com/alexreisner/geocoder).
+
+## Bootstrap
+
+### `row_groups_of`
+
+Makes a series of row/col `div` elements based in group count.
+
+```
+<% row_groups_of(3, [1,2,3,4,5,6,7,8,9]) do |i| %>
+  <div class="panel panel-default">
+    <div class="panel-heading">
+      <h2 class="text-center"><%= i %></h2>
+    </div>
+  </div>
+<% end %>
+```

data/Rakefile

@@ -1,37 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
 begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Minimum Viable Product'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "minimum_viable_product"
+  gem.homepage = "http://github.com/ian/minimum_viable_product"
+  gem.license = "MIT"
+  gem.summary = %Q{The start-to-finish 3 minute product platform}
+  gem.description = %Q{Built for Developers. Ideal for MVPs, product ideation and validation.}
+  gem.email = "ianhunter@gmail.com"
+  gem.authors = ["Ian Hunter"]
+  # dependencies defined in Gemfile
 end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
-load 'rails/tasks/statistics.rake'
-
-
-
-Bundler::GemHelper.install_tasks
+Jeweler::RubygemsDotOrgTasks.new
 
 require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
 end
 
+task :default => :test
 
-task default: :test
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "minimum_viable_product #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.2

data/assets/js/application.js

@@ -0,0 +1,48 @@
+require('jquery')
+require('jquery-ujs')
+require('jquery.cookie')
+// var _  = require('lodash')
+var is = require('is')
+
+require('./init/controllers')
+require('./init/forms')
+
+track = function(event, attributes, fn){
+  console.log("Track: " + event + " " + JSON.stringify(attributes))
+
+  if (is.fn(attributes)) fn = attributes, attributes = null;
+  if (is.undefined(attributes)) { attributes = {} }
+  if ($.cookie('invisible') == "true") {
+    if (!is.undefined(fn)) { fn() }
+    return
+  }
+
+  if (typeof(analytics) == 'undefined') {
+    return
+  }
+
+  attrs = _.extend({
+    iteration: $('body').data('iteration')
+  }, attributes)
+
+  analytics.track(event, attrs, fn)
+}
+
+setupAutomaticTracing = function(){
+  _.each(arguments, function(e){
+    switch (e.toLowerCase()) {
+      case 'buttons':
+        $('.btn').on('click', function(){
+          window.track("Button Clicked", { name: $(this).text() || $(this).attr('value') })
+        })
+        break;
+      case 'links':
+        $('a:not(.btn)').on('click', function(){
+          window.track("Link Clicked", { name: ($(this).text() || $(this).attr('value')) })
+        })
+        break;
+    }
+  })
+}
+
+window.track = track;

data/assets/js/init/controllers.js

@@ -0,0 +1,23 @@
+window.controllers = {}
+
+$(function() {
+  var $body = $("body");
+  var controller = $body.data("controller").replace(/\//g, "_");
+  var action = $body.data("action");
+
+  var activeController = window.controllers[controller];
+
+  if (activeController !== undefined) {
+    if (window.env == "development") {
+      console.log("[Controllers] " + controller + "." + action + "()");
+    }
+
+    if ($.isFunction(activeController.init)) {
+      activeController.init();
+    }
+
+    if ($.isFunction(activeController[action])) {
+      activeController[action]();
+    }
+  }
+});

data/assets/js/init/forms.js

@@ -0,0 +1,12 @@
+$(function(){
+  $('form.no-enter-submit').bind("keypress", function(e) {
+    if (e.keyCode == 13) {
+      e.preventDefault();
+      return false;
+    }
+  });
+
+  $('form.disable-on-submit').on('submit', function(e){
+    $(this).find(".btn").addClass('disabled')
+  })
+})

data/bin/mvp

@@ -51,8 +51,8 @@ when 'update'
   # https://github.com/npm/npm/issues/1341
   run "rm -rf node_modules; npm install"
 when '-v','version'
-  require_relative '../lib/minimum_viable_product/version'
-  puts "Version #{MinimumViableProduct::VERSION}"
+  version = File.read(File.dirname(__FILE__) + '/../VERSION') 
+  puts "Version #{version}"
 end
 
 BEGIN {

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/minimum_viable_product/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/lib/minimum_viable_product/engine.rb

@@ -17,7 +17,7 @@ require_relative './ext/string'
 module MinimumViableProduct
   class Engine < ::Rails::Engine
     isolate_namespace MinimumViableProduct
-    config.autoload_paths << "#{Rails.root}/app"
-    config.autoload_paths << "#{Rails.root}/lib"
+    # config.autoload_paths << "#{Rails.root}/app"
+    # config.autoload_paths << "#{Rails.root}/lib"
   end
 end

data/mvp.gemspec

@@ -0,0 +1,45 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "minimum_viable_product/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "minimum_viable_product"
+  s.version     = MinimumViableProduct::VERSION
+  s.authors     = ["Ian Hunter"]
+  s.email       = ["ianhunter@gmail.com"]
+  s.homepage    = "http://github.com/ian/minimum_viable_product"
+  s.summary     = "The start-to-finish 3 minute product platform"
+  s.description = "Built for Developers. Ideal for MVPs, product ideation and validation."
+  s.license     = "MIT"
+
+  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
+  # s.files = Dir["engine/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
+  s.test_files = Dir["test/**/*"]
+  s.executables = ['mvp']
+
+  s.add_dependency 'analytics-ruby'
+  s.add_dependency 'carrierwave'
+  s.add_dependency "cloudinary"
+  s.add_dependency "geocoder"
+  s.add_dependency 'faraday'
+  s.add_dependency 'fog'
+  s.add_dependency 'fog-aws'
+  s.add_dependency "hashie"
+  s.add_dependency "rack-canonical-host"
+  s.add_dependency 'rack-ssl-enforcer'
+  s.add_dependency "rails", "~> 4.2.3"
+  s.add_dependency 'rollbar'
+  s.add_dependency 'sass-rails', '~> 5.0'
+  s.add_dependency 'sitemap_generator'
+  s.add_dependency 'slack-notifier'
+
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "better_errors"
+  s.add_development_dependency "binding_of_caller"
+  s.add_development_dependency "bullet"
+  s.add_development_dependency "semantic"
+  s.add_development_dependency 'web-console', '~> 2.0'
+  s.add_development_dependency 'spring'
+end

data/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "minimum_viable_product",
+  "private": true,
+  "version": "1.0.0",
+  "description": "= MVP",
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "postinstall": "rm -rf app"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ian/minimum_viable_product.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/ian/minimum_viable_product/issues"
+  },
+  "homepage": "https://github.com/ian/minimum_viable_product#readme",
+  "dependencies": {
+    "coffee-loader": "^0.7.2",
+    "coffee-script": "^1.10.0",
+    "css-loader": "^0.24.0",
+    "es6-loader": "^0.2.0",
+    "extract-text-webpack-plugin": "^1.0.1",
+    "file-loader": "^0.9.0",
+    "font-awesome": "^4.6.3",
+    "is": "^3.1.0",
+    "jquery": "^3.1.0",
+    "jquery-ujs": "^1.2.2",
+    "jquery.cookie": "^1.4.1",
+    "lodash": "^4.14.1",
+    "node-sass": "^3.8.0",
+    "resolve-url": "^0.2.1",
+    "resolve-url-loader": "^1.6.0",
+    "sass-loader": "^4.0.1",
+    "style-loader": "^0.13.1",
+    "webpack": "^1.13.2"
+  }
+}

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'minimum_viable_product'
+
+class Test::Unit::TestCase
+end

data/test/test_minimum_viable_product.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMinimumViableProduct < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end