myrails 1.0.0

data/lib/myrails/templates/mailer/dev_mail_interceptor.rb

@@ -0,0 +1,27 @@
+# @author Lovell McIlwain
+#
+# Mail interceptor for development and test emails
+require 'socket'
+class DevMailInterceptor
+  def self.delivering_email(message)
+    dev_text = "\n\n\n------------\n"
+    dev_text += "To address is: #{message.to.to_a.join(", ")}\n"
+    dev_text += "CC address is: #{message.cc.to_a.join(", ")}\n"
+    dev_text += "BCC address is: #{message.bcc.to_a.join(", ")}\n"
+
+    message.subject = "[#{Socket.gethostname}] [#{Rails.env}] #{message.subject}"
+    message.to = '<%= options[:email]%>'
+    message.cc = ""
+    message.bcc = ""
+    append_address_info(message, dev_text)
+  end
+
+  def self.append_address_info(part, dev_text)
+    case part.content_type
+      when %r{^text/plain} then part.body = part.body.to_s + dev_text
+      when %r{^text/html} then part.body = part.body.to_s + ("<pre>#{dev_text}</pre>").html_safe
+    end
+    part.parts.each { |p| append_address_info(p, dev_text)}
+  end
+
+end

data/lib/myrails/templates/mailer/sendgrid.rb

@@ -0,0 +1,8 @@
+# config.action_mailer.delivery_method = :smtp
+# config.action_mailer.smtp_settings = { address:              'smtp.sendgrid.net',
+#                                      port:                 587,
+#                                      domain:               'yourdomain.com',
+#                                      user_name:            'someuser',
+#                                      password:             'somepassword',
+#                                      authentication:       'plain',
+#                                      enable_starttls_auto: true }

data/lib/myrails/templates/presenters/base.rb

@@ -0,0 +1,33 @@
+# @author Lovell McIlwain
+#
+# Class every presenter class should inherit from
+class BasePresenter
+  # Initialize class with object to be presented and the view it is to be presented on
+  def initialize(object, template)
+    @object = object
+    @template = template
+  end
+
+  # Same as application helper short date
+  def format_date(date)
+    date.strftime("%Y-%m-%d")
+  end
+
+private
+ # Class method to call the object by its class
+  def self.presents(name)
+    define_method(name) do
+      @object
+    end
+  end
+
+  # Accessor for template methods
+  def t
+    @template
+  end
+
+  # In the event a method called can't be found, default to the template methods
+  def method_missing(*args, &block)
+    @template.send(*args, &block)
+  end
+end

data/lib/myrails/templates/presenters/presenter.rb

@@ -0,0 +1,19 @@
+# @author Lovell McIlwain
+#
+# Presenter class for object views
+class <%= options[:name].camelize %>Presenter < BasePresenter
+  # Reference initialized object_presenter as object
+  presents :<%= options[:name]%>
+
+  # delegate :attribute, to: :object, allow_nil: true
+
+  # Return concatenated full name
+  def name
+    <%= options[:name]%>.attribute + " " + <%= options[:name]%>.attribute
+  end
+
+  # Return edit path
+  def edit_link
+    link_to :Edit, edit_<%= options[:name]%>_path(<%= options[:name]%>)
+  end
+end

data/lib/myrails/templates/presenters/presenter_config.rb

@@ -0,0 +1,4 @@
+# Presenter tests requre this metho in order to fuction.
+def include_behavior
+  include ActionView::TestCase::Behavior
+end

data/lib/myrails/templates/presenters/presenter_spec.rb

@@ -0,0 +1,17 @@
+
+require 'rails_helper'
+#
+describe <%= options[:name].camelize %>Presenter do
+  include_behavior
+
+  let(:presenter) {<%= options[:name].camelize %>Presenter.new(<%= options[:name] %>, view)}
+  let(:<%= options[:name] %>) {create :<%= options[:name] %>}
+
+  it 'returns name' do
+    expect(presenter.name).to eq object.attribute + " " + object.attribute
+  end
+
+  it 'returns edit path' do
+    expect(presenter.edit_link).to eq link_to :Edit, edit_<%= options[:name] %>_path(<%= options[:name] %>)
+  end
+end

data/lib/myrails/templates/rails/application_helper.rb

@@ -0,0 +1,49 @@
+module ApplicationHelper
+  # Long date format
+  #
+  # @param date [Date] the date object
+  # @return day date month year - hour:minutes AM/PM
+  def long_date(date)
+    date.strftime("%A %d %B %Y - %H:%M %p") rescue 'unknown'
+  end
+
+  # Medium date format
+  #
+  # @param date [Date] the date object
+  # @return month/date/year at hour:minutes AM/PM
+  def medium_date(date)
+    date.strftime("%m/%d/%Y at %H:%M %p") rescue 'unknown'
+  end
+
+  # Another style of medium date format
+  #
+  # @param date [Date] the date object
+  # @return day/MONTH/YEAR
+  # Produces -> 18 October 2015
+  def medium_date2(date)
+    date.strftime("%d %B %Y") rescue 'unknown'
+  end
+
+  # Short date format
+  #
+  # @param date [Date] the date object
+  # @return year-month-date
+  def short_date(date)
+    date.strftime("%Y-%m-%d") rescue 'unknown'
+  end
+
+  # US date format
+  #
+  # @param date [Date] the date object
+  # @return year-month-date
+  def us_date(date)
+    date.strftime("%m/%d/%Y at %H:%M %p") rescue 'unknown'
+  end
+
+  def present(object, klass = nil)
+    klass ||= "#{object.class}Presenter".constantize
+    presenter = klass.new(object, self)
+    yield presenter if block_given?
+    presenter
+  end
+end

data/lib/myrails/templates/rails/controller.rb

@@ -0,0 +1,12 @@
+class <%= options[:name].pluralize.camelize %>Controller < ApplicationController
+  # before_action :<%= options[:name].singularize %>, only: []
+  private
+
+  def <%= options[:name].singularize %>
+    @<%= options[:name] %> = Object.find(params[:id])
+  end
+
+  def <%= options[:name].singularize %>_params
+    params.require(:<%= options[:name] %>).permit()
+  end
+end

data/lib/myrails/templates/rails/model.rb

@@ -0,0 +1,2 @@
+class <%= options[:name].camelize %> < ActiveRecord::Base
+end

data/lib/myrails/templates/rails/pundit.rb

@@ -0,0 +1,26 @@
+# @author Lovell McIlwain
+#
+# Authorization for article objects
+class <%= options[:name].camelize %>Policy < ApplicationPolicy
+  # Allow all users to access new article objects
+  def new?
+    true
+  end
+
+  # Allows owner of an article to edit the article
+  def edit?
+    user == record.user
+  end
+
+  # Allows all users to create article objects
+  alias_method :create?, :new?
+
+  # Allows all users to view article objects
+  alias_method :show?, :new?
+
+  # Allows owner of an article to update an article object
+  alias_method :update?, :edit?
+
+  # Allows owner of an object to remove an object
+  alias_method :destroy?, :edit?
+end

data/lib/myrails/templates/rspec/controller.rb

@@ -0,0 +1,98 @@
+require 'rails_helper'
+
+# Does this controller require authentication?
+describe <%= options[:name].camelize %>Controller do
+  # let(:user) {create :user}
+  let(:<%= options[:name].pluralize %>) {[]}
+  let(:<%= options[:name].singularize %>) {create :<%= options[:name].singularize %>}
+
+  # before {sign_in user}
+
+  describe 'GET index' do
+    before do
+      3.times {<%= options[:name].pluralize %> << create(:<%= options[:name].singularize %>)}
+      get :index
+    end
+
+    it 'sets @<%= options[:name].pluralize %>' do
+      expect(assigns[:<%= options[:name].pluralize %>]).to eq <%= options[:name].pluralize %>
+    end
+  end
+
+  describe 'GET show' do
+    before {get :show, params: {id: <%= options[:name].singularize %>.id}}
+
+    it 'sets @<%= options[:name].singularize %>' do
+      expect(assigns[:<%= options[:name].singularize %>]).to eq <%= options[:name].singularize %>
+    end
+  end
+
+  describe 'GET new' do
+    before {get :new}
+
+    it 'sets @<%= options[:name].singularize %>' do
+      expect(assigns[:<%= options[:name].singularize %>]).to be_a_new <%= options[:name].singularize.camelize %>
+    end
+  end
+
+  describe 'POST create' do
+    context 'successful create' do
+      before {post :create, params: {<%= options[:name].singularize %>: attributes_for(:<%= options[:name].singularize %>)}}
+
+      subject(:<%= options[:name].first %>){assigns[:<%= options[:name].singularize %>]}
+
+      it 'redirects to :show'
+      it 'sets @<%= options[:name].singularize %>'
+      it 'sets flash[:success]'
+      it 'tags the current_user as creator'
+    end
+
+    context 'unsuccessful create' do
+      before {post :create, params: {<%= options[:name].singularize %>: attributes_for(:<%= options[:name].singularize %>, attr: nil)}}
+
+      it 'renders :new template'
+      it 'sets @<%= options[:name].singularize %>'
+      it 'sets flash[:error]'
+    end
+  end
+
+  describe 'GET edit' do
+    before {get :edit, params: {id: <%= options[:name].singularize %>.id}}
+
+    it 'sets @<%= options[:name].singularize %>' do
+      expect(assigns[:<%= options[:name].singularize %>]).to eq <%= options[:name].singularize %>
+    end
+  end
+
+  describe 'PUT/PATCH update' do
+    context 'successful update' do
+      before {put :update, params: {id: <%= options[:name].singularize %>.id, <%= options[:name].singularize %>: attributes_for(:<%= options[:name].singularize %>)}}
+
+      subject(:<%= options[:name].first %>) {assigns[:<%= options[:name].singularize %>]}
+
+      it 'redirects to :show'
+      it 'sets @<%= options[:name].singularize %>'
+      it 'sets flash[:success]'
+      it 'tags current_user as updater'
+    end
+
+    context 'unsuccessful update' do
+      before {put :update, params: {id: <%= options[:name].singularize %>.id, <%= options[:name].singularize %>: attributes_for(:<%= options[:name].singularize %>, attr: nil)}}
+
+      it 'renders :edit template'
+      it 'sets @<%= options[:name].singularize %>'
+      it 'sets flash[:error]'
+    end
+  end
+
+  describe 'DELETE destroy' do
+    before {delete :destroy, params: {id: <%= options[:name].singularize %>.id}}
+
+    it 'redirects to :index' do
+      expect(response).to redirect_to <%= options[:name].pluralize %>_path
+    end
+    it 'sets @<%= options[:name].singularize %>'
+    it 'deletes @<%= options[:name].singularize %>'
+    it 'sets flash[success]'
+  end
+end

data/lib/myrails/templates/rspec/database_cleaner.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  # => database cleaner configs
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/lib/myrails/templates/rspec/devise.rb

@@ -0,0 +1,38 @@
+RSpec.configure do |config|
+  config.include Devise::Test::ControllerHelpers, type: :controller
+  # config.include Devise::TestHelpers, type: :controller
+  config.include Devise::TestHelpers, type: :view
+end
+
+# Authenticate without going through the login process
+RSpec.configure do |config|
+  config.include Warden::Test::Helpers
+  config.before :suite do
+    Warden.test_mode!
+  end
+end
+
+RSpec.configure do |config|
+  config.after :each do
+    Warden.test_reset!
+  end
+end
+#
+=begin
+Reference: https://github.com/plataformatec/devise/wiki/How-To:-Test-with-Capybara
+
+To use authentication bypass use the following for loging in:
+
+user = FactoryGirl.create(:user)
+login_as(user, :scope => :user)
+
+if within a test you need to logout a user use:
+logout(:user)
+=end
+
+def sign_in_with(user)
+  click_link 'Sign In'
+  fill_in 'user_email', with: user.email
+  fill_in 'user_password', with: 'somepassword'
+  click_button 'Log in'
+end

data/lib/myrails/templates/rspec/factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :<%= options[:name] %> do
+
+  end
+end

data/lib/myrails/templates/rspec/factory_girl.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/lib/myrails/templates/rspec/files.rb

@@ -0,0 +1,3 @@
+def delete_files
+  `rm -rf \#{Rails.root}/tmp/uploads`
+end

data/lib/myrails/templates/rspec/javascript.rb

@@ -0,0 +1,8 @@
+module JavascriptHelper
+  # Basecamp trix uses hidden input to populate its editor
+  def fill_in_trix_editor(id, value)
+    find(:xpath, "//*[@id='#{id}']", visible: false).set(value)
+  end
+end
+
+# Example of use in feature test: fill_in_trix_editor("blog_comment_body_trix_input_blog_comment_#{blog_comment.id}", "some text")

data/lib/myrails/templates/rspec/mailer.rb

@@ -0,0 +1,7 @@
+def inbox
+   ActionMailer::Base.deliveries
+end
+
+def clear_inbox
+  ActionMailer::Base.deliveries.clear
+end

data/lib/myrails/templates/rspec/model.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+describe <%= options[:name].camelize %> do
+
+end

data/lib/myrails/templates/rspec/pundit.rb

@@ -0,0 +1,28 @@
+# Use with Pundit Matches: https://github.com/chrisalley/pundit-matchers
+require 'rails_helper'
+describe <%= options[:name].camelize %>Policy do
+  subject { <%= options[:name].camelize %>Policy.new(user, <%= options[:name] %>) }
+
+  let(:<%= options[:name] %>) { create :<%= options[:name] %> }
+
+  context 'for a visitor' do
+    it {is_expected.to permit_action(:new)}
+    it {is_expected.to permit_action(:create)}
+    it {is_expected.to permit_action(:show)}
+    it {is_expected.to forbid_action(:edit)}
+    it {is_expected.to forbid_action(:update)}
+    it {is_expected.to forbid_action(:destroy)}
+  end
+
+  context "for an admin" do
+
+    let(:user) { <%= options[:name] %>.user }
+
+    it {is_expected.to permit_action(:new)}
+    it {is_expected.to permit_action(:create)}
+    it {is_expected.to permit_action(:show)}
+    it {is_expected.to permit_action(:edit)}
+    it {is_expected.to permit_action(:update)}
+    it {is_expected.to permit_action(:destroy)}
+  end
+end

data/lib/myrails/templates/rspec/pundit_matchers.rb

@@ -0,0 +1,47 @@
+RSpec::Matchers.define :permitted_to do |action|
+  match do |policy|
+    policy.public_send("#{action}?")
+  end
+
+  failure_message do |policy|
+    "#{policy.class} does not permit #{action} on #{policy.record} for #{policy.user.inspect}."
+  end
+
+  failure_message_when_negated do |policy|
+    "#{policy.class} does not forbid #{action} on #{policy.record} for #{policy.user.inspect}."
+  end
+end
+
+def pundit_error
+  Pundit::NotAuthorizedError
+end
+
+=begin
+
+example: spec/policies/projects_policy_spec.rb
+
+require 'rails_helper'
+
+describe ProjectPolicy do
+  subject { ProjectPolicy.new(user, project) }
+  let(:project) { Fabricate :project }
+
+
+  context 'for a visitor' do
+    it { should_not permitted_to(:create)  }
+    it { should_not permitted_to(:new)     }
+    it { should_not permitted_to(:update)  }
+    it { should_not permitted_to(:edit)    }
+  end
+
+  context "for an admin" do
+    let(:user) { Fabricate(:user, admin: true) }
+
+    it { should permitted_to(:create)  }
+    it { should permitted_to(:new)     }
+    it { should permitted_to(:update)  }
+    it { should permitted_to(:edit)    }
+  end
+end
+
+=end

data/lib/myrails/templates/rspec/router.rb

@@ -0,0 +1,7 @@
+# Controller test doesn't seem to use default url option when redirecting to an associated record. Uses http://test.com. This is an attmept to unify this and capybara which uses http://www.example.com.
+# Add this method to the before action of any controller specs that needed it. Found it useful to use this when using shared examples.
+RSpec.configure do |config|
+  config.before(:each) do
+    @request.host = 'localhost:3000'
+  end
+end

data/lib/myrails/templates/rspec/shoulda_matchers.rb

@@ -0,0 +1,16 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    # Choose a test framework:
+    with.test_framework :rspec
+    # with.test_framework :minitest
+   #  with.test_framework :minitest_4
+   #  with.test_framework :test_unit
+
+    # Choose one or more libraries:
+    # with.library :active_record
+    # with.library :active_model
+    # with.library :action_controller
+    # Or, choose the following (which implies all of the above):
+    with.library :rails
+  end
+end

data/lib/myrails/templates/rspec/silence_backtrace.rb

@@ -0,0 +1,8 @@
+# Supress stacktrace when specs fail
+RSpec.configure do |config|
+  config.backtrace_exclusion_patterns = [/\/lib\d*\/ruby\//,
+                                          /org\/jruby\//,
+                                          /bin\//,
+                                          /gems\//,
+                                          /lib\/rspec\/(core|expectations|matchers|mocks)/]
+end

data/lib/myrails/templates/ui/index.html.haml

@@ -0,0 +1,6 @@
+%section.ui-index
+  %ul
+    - Dir.glob('app/views/ui/*.html.haml').sort.each do |file|
+      - wireframe = File.basename(file,'.html.haml')
+      -  unless wireframe == 'index' || wireframe.match(/^_/)
+        %li= link_to wireframe.titleize, action: wireframe unless wireframe == 'index'

data/lib/myrails/templates/ui/ui_controller.rb

@@ -0,0 +1,8 @@
+# @author Lovell McIlwain
+# Handles HTTP actions for UI
+class UiController < ApplicationController
+  # Before filter to check if application is running in development
+   before_action do
+    redirect_to :root if Rails.env.production?
+  end
+end

data/lib/myrails/version.rb

@@ -0,0 +1,3 @@
+module Myrails
+  VERSION = "1.0.0"
+end