kitestrings 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0cfbc92932ce23470326d07836d6ef8ba8d24f6
+  data.tar.gz: a2c6b9b841e88fd63910f46bd36f80b7a25a3c3e
+SHA512:
+  metadata.gz: afa6ba0918b66edd5d24c2ab9457f0548f95cb842049473cc1413b9d18780be556782a5b0d0c3ca2659a85b1bf74adf6b79af830bcfb044b2f94edf0cfd47237
+  data.tar.gz: b4e6825be0f105315cb4108b2259fcc02b2adafc753be9c859ed0445094269185767cd8c1cd0d757625ce729ce9efce0128b523cc3d3bf5eeffc44f5f8ed8cf0

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ridget
+
+MIT License
+
+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,38 @@
+# Kitestrings
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kitestrings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kitestrings
+
+Once installed run
+
+    rails g kitestrings:install
+
+If installed using our template file, this will already be done for you.
+
+## Contains
+
+Our scaffold templates (views, controlller)
+
+A rake task which will run `db:test:prepare` after you run a migration and `db:fixtures:load` so your selections are properly
+loaded in the test db.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kitestrings/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc "Run the specs."
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => [:spec]

data/kitestrings.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitestrings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kitestrings"
+  spec.version       = Kitestrings::VERSION
+  spec.authors       = ["ridget"]
+  spec.email         = ["tom.ridge@tworedkites.com"]
+  spec.summary       = %q{For all the 2rk goodness}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  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_runtime_dependency "rails", ">= 3.2"
+  spec.add_runtime_dependency "activemodel", ">= 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency 'generator_spec'
+end

data/lib/array_validator.rb

@@ -0,0 +1,22 @@
+# A validator to validate the length of an array. Only works on values that are arrays. (Not relationships in Rails 4)
+class ArrayValidator < ActiveModel::EachValidator
+  # Validate the value is an Array and optionally that the number of items in it is at least a minimum or at most a
+  # maximum.
+  #
+  # Example:
+  #  validates :address_states, array: {min: 1, min_message: "must have at least 1 State selected"},
+  #
+  def validate_each(record, attribute, value)
+    if value.is_a? Array
+      if options[:min].present? && value.size < options[:min]
+        record.errors.add attribute, options[:min_message] || "must have at least #{options[:min]} #{'item'.pluralize(options[:min])}"
+      end
+
+      if options[:max].present? && value.size > options[:max]
+        record.errors.add attribute, options[:max_message] || "must have at most #{options[:max]} #{'item'.pluralize(options[:max])}"
+      end
+    else
+      record.errors.add attribute, "must be an array"
+    end
+  end
+end

data/lib/async.rb

@@ -0,0 +1,26 @@
+require 'active_support'
+
+# a module for executing code asynchronously in another thread. This is disabled
+module Async
+  mattr_accessor :enabled
+
+  # Execute the given block in another thread, but only in production. During development, the block executes
+  # on the current thread
+  # @return [Thread]
+  def async
+    raise "A block must be provided" unless block_given?
+    if Async.enabled
+      Thread.new do
+        # ensure that this thread uses a new connection to the database and returns it to the pool when done.
+          ActiveRecord::Base.connection_pool.with_connection do
+          yield
+        end
+      end
+    else
+      yield
+      Thread.current
+    end
+  end
+end
+
+Async.enabled = false

data/lib/form_object.rb

@@ -0,0 +1,96 @@
+# This module is to help with using Form Objects that are backed by ActiveRecord resources. The goal
+# is to make a from object act like the underlying model class, but with its own set of validations.
+#
+# Note that saving the form object requires validations in the form object to pass *AND* the validations
+# in the underlying model object. Validation errors in the underlying model object will be included in
+# the errors of the form object.
+module FormObject
+  extend ActiveSupport::Concern
+  include ActiveModel::Model
+  include ActiveRecord::AttributeAssignment
+  include ActiveRecord::Persistence
+
+  module ClassMethods
+    # Set up the Form Object class to be a form object for a given model.
+    #
+    # Example:
+    #
+    # class NewWorkflow
+    #   include FormObject
+    #   form_object_for :workflow, :fields => [:name], :class => MyOtherClass
+    #   ...
+    #
+    # This creates a :workflow attr method and delegates methods to it for use with form_for.
+    def form_object_for(resource_name, options={})
+      # create an attribute for the underlying resource name, (eg :workflow) and make an alias method "resource"
+      # for the attr reader
+      attr resource_name
+      alias_method :resource, resource_name
+
+      # create a class attribute with the model name of the underlying model name so that polymorphic_url will
+      # see the form object as if it were an instance of the underlying model object.
+      class_attribute :model_name
+      klass = options[:class] || resource_name.to_s
+      klass = klass.camelize.constantize unless klass.is_a?(Class)
+      self.model_name = klass.model_name
+
+      # delegate the following methods to the underlying model object, also helps polymorphic_url do the right thing
+      # for `form_for @form_object`
+      methods_to_delegate = [:id, :persisted?, :to_param]
+      if options[:fields]
+        options[:fields].each do |field|
+          methods_to_delegate << "#{field}".to_sym
+          methods_to_delegate << "#{field}=".to_sym
+        end
+      end
+      delegate *methods_to_delegate, :to => resource_name
+      include DelegateEverything if options[:delegate_everything]
+
+      # create a default initializer which will set the resource when a single parameter is passed in.
+      define_method :initialize do |object=nil|
+        instance_variable_set("@#{resource_name}", object)
+      end
+    end
+  end
+
+  # Validate the form object and if it's valid, call save on the underlying model object. If there are multiple models
+  # that need to be saved you will need to reimplement this method.
+  def save(*args)
+    if valid?
+      resource.save
+    end
+  end
+
+  # The form object is valid when its validations pass *AND* the underlying model validations pass. If there
+  # are errors in the underlying resource, those errors are copied into the errors object for this form object
+  # so that they exist in a single place (easy for the form to work with)
+  def valid?
+    result = [super, resource.valid?].all?
+
+    # include any errors in the resource object in the +errors+ for this form object. This is useful
+    # for uniqueness validation or existing validations in the model class so that they don't need
+    # to be duplicated in the form object. (And especially uniqueness validators can only be run in
+    # the ActiveRecord::Base model class.
+    unless result
+      resource.errors.each do |attr, error|
+        errors[attr] << error unless errors[attr].include?(error)
+      end
+    end
+
+    result
+  end
+
+  module DelegateEverything
+    def method_missing(method, *args, &block)
+      if resource.respond_to?(method)
+        resource.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_all)
+      resource.respond_to?(method, include_all) || super
+    end
+  end
+end

data/lib/generators/kitestrings/install_generator.rb

@@ -0,0 +1,41 @@
+require 'rails'
+require 'rails/generators'
+
+module Kitestrings
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Copies 2rk relevant templates to the relevant directory"
+
+      def copy_deploy
+        copy_file "deploy.rb", "config/deploy.rb"
+      end
+
+      def copy_deploy_files
+        directory "deploy", "config/deploy"
+      end
+
+      def copy_haml_files
+        directory "haml", "lib/templates/haml"
+      end
+
+      def copy_scaffold_files
+        directory "rails", "lib/templates/rails"
+      end
+
+      def copy_rspec_files
+        directory "rspec", "lib/templates/rspec"
+      end
+
+      def copy_spec_ext
+        directory "spec_ext", "spec_ext"
+      end
+
+      def copy_app_view_files
+        copy_file "views/application/_navigation.html.haml", "app/views/application/_navigation.html.haml"
+        copy_file "views/layouts/application.html.haml", "app/views/layouts/application.html.haml"
+      end
+    end
+  end
+end

data/lib/generators/kitestrings/messages_generator.rb

@@ -0,0 +1,11 @@
+module Kitestrings
+  module Generators
+    class MessagesGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def setup_messages_model
+        template "message.rb.erb", "app/models/message.rb"
+      end
+    end
+  end
+end

data/lib/generators/kitestrings/templates/message.rb.erb

@@ -0,0 +1,56 @@
+class Message < ActiveRecord::Base
+  include Async
+
+  DELIVERY_TIMEOUT = 5
+
+<%- if Rails.version =~ /^3/ %>
+  attr_accessible :clicked_at, :link, :sent_at, :template, :user_id, :user, :options, :context, :subject
+
+<% end %>
+  serialize :options
+
+  include Rails.application.routes_url_helpers
+
+  after_create :send_email
+
+  ## RELATIONSHIPS
+
+  belongs_to :context, polymorphic: true
+  belongs_to :user
+
+  ## VALIDATIONS
+
+  validates :user, presence: true
+
+  ## SCOPES
+
+  scope :latest, -> { order('created_at DESC') }
+
+  ## METHODS
+
+  def send_email
+    async do
+      Timeout.timeout DELIVERY_TIMEOUT do
+        mail.deliver
+
+        # always update the sent at, even if the email address is not on the whitelist to simulate what would happen
+        self.update_column(:sent_at, Time.now)
+      end
+    end
+  end
+
+  # prepare a mail object ready for delivery by email or display on the screen
+  def mail
+    @mail ||= MessageMailer.prepare_message(self, context)
+  end
+
+  # The "view" link. This is the link to the messages controller that marks the message
+  # as "clicked" and redirects to the actual link stored in the message record.
+  def view_link
+    message_url(self, :only_path => false)
+  end
+
+  def name
+    "Message ID: #{id}"
+  end
+end

data/lib/generators/templates/deploy.rb

@@ -0,0 +1,136 @@
+require 'bundler/capistrano'
+require 'rvm/capistrano'
+require 'capistrano/ext/multistage'
+require 'airbrake/capistrano'
+
+set :stages, %w(integ, uat, production)
+set :default_stage, "integ"
+set :application, 'pwi'
+set :user, 'pwi'
+set (:deploy_to) { "/home/#{user}/apps/#{rails_env}" }
+set :deploy_via, :remote_cache
+set :use_sudo, false
+set :scm, 'git'
+#set :repository, 'git@github.com:2rk/pwi.git'
+
+set :ssl, false
+# set :ssl_certificates_path, '/home/amt/ssl'
+# set :ssl_certificates_name, 'amt'
+
+set :mysql_password, YAML::load_file("config/database.yml.server")["production"]["password"]
+set :bundle_flags, "--deployment"
+
+namespace :deploy do
+
+  task :airbrake_test do
+    run "cd #{current_path}; RAILS_ENV=#{stage} bin/rake airbrake:test; true"
+  end
+
+  task :nginx_conf do
+    set :nginx_conf_file, "/opt/nginx/conf/servers/#{application}_#{stage}.conf"
+
+    ssl_conf = <<ssl_conf
+  ssl on;
+  ssl_certificate #{ssl_certificates_path}/#{ssl_certificates_name}.crt;
+  ssl_certificate_key #{ssl_certificates_path}/#{ssl_certificates_name}.key;
+
+  passenger_set_cgi_param HTTPS on;
+  passenger_set_cgi_param SSL_CLIENT_S_DN $ssl_client_s_dn;
+  passenger_set_cgi_param SSL_CLIENT_VERIFY $ssl_client_verify;
+
+  passenger_set_cgi_param HTTP_X_FORWARDED_PROTO https;
+}
+
+server {
+  listen      80;
+  server_name #{hostnames};
+  rewrite     ^   https://#{hostnames}$request_uri? permanent;
+ssl_conf
+
+    conf = <<conf
+server {
+  listen #{ssl ? 443 : 80};
+  server_name #{user}.#{stage}.tworedkites.com #{hostnames};
+  root /home/#{user}/apps/#{stage}/current/public;
+  passenger_enabled on;
+  passenger_ruby /usr/local/rvm/bin/#{application}_ruby;
+  rack_env production;
+  client_max_body_size 10m;
+
+#{ssl_conf}
+}
+conf
+
+    put(conf, nginx_conf_file)
+
+    run "sudo service nginx reload"
+  end
+
+
+  task :github_ssh_key do
+    run "ssh-keygen -t rsa -f ~/.ssh/id_rsa -P ''; ssh -oStrictHostKeyChecking=no git@github.com; cat .ssh/id_rsa.pub"
+  end
+
+  task :symlink_config do
+    run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml"
+  end
+  before "deploy:assets:precompile", "deploy:symlink_config"
+
+  task :create_shared_database_config do
+    run "mkdir -p #{shared_path}/config"
+    top.upload File.expand_path('../database.yml.server', __FILE__), "#{shared_path}/config/database.yml"
+  end
+
+
+  task :create_shared_rvmrc do
+    run "cp #{release_path}/.rvmrc.#{rails_env}.example #{release_path}/.rvmrc"
+  end
+
+  after "deploy:finalize_update", "deploy:create_shared_rvmrc"
+
+  task :create_database do
+    set :mysql_pass_arg, mysql_password.blank? ? '' : "-p#{mysql_password}"
+    run "mysql --user=root #{mysql_pass_arg} -e \"CREATE DATABASE IF NOT EXISTS #{application}_#{stage}\""
+  end
+
+  task :restart, :roles => :app, :except => { :no_release => true } do
+    run "#{try_sudo} touch #{File.join(current_path,'tmp','restart.txt')}"
+  end
+end
+
+namespace :ruby_make do
+  desc "Run a task on a remote server."
+  # run like: cap staging rake:invoke task=a_certain_task
+  task :invoke do
+    run("cd #{deploy_to}/current; /usr/bin/env rake #{ENV['task']} RAILS_ENV=#{rails_env}")
+  end
+end
+
+# if you want to clean up old releases on each deploy uncomment this:
+# after "deploy:restart", "deploy:cleanup"
+
+# if you're still using the script/reaper helper you will need
+# these http://github.com/rails/irs_process_scripts
+
+# If you are using Passenger mod_rails uncomment this:
+namespace :deploy do
+  task :start do ; end
+  task :stop do ; end
+  task :restart, :roles => :app, :except => { :no_release => true } do
+    run "#{try_sudo} touch #{File.join(current_path,'tmp','restart.txt')}"
+  end
+  desc "reload the database with seed data"
+  task :seed do
+    run "cd #{current_path}; bundle exec rake db:seed RAILS_ENV=#{rails_env}"
+  end
+end
+
+namespace :rvm do
+  task :trust_rvmrc do
+    run "rvm rvmrc trust #{release_path}"
+  end
+end
+
+after "deploy", "rvm:trust_rvmrc"
+after 'deploy:setup', 'deploy:create_database', 'deploy:github_ssh_key', 'deploy:nginx_conf', 'deploy:create_shared_database_config'
+after 'deploy:cold', 'deploy:airbrake_test'