silmarails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5038a4b76855b99d2b34ffb7a2b6755a6d660737
+  data.tar.gz: c024c7cc2899c518f5c14405b270b5393fc92c7a
+SHA512:
+  metadata.gz: 8c0ca654399858d4c8ff9f481253df488ac4e6669ca013c10e9be4c2c2e12c006964df526aee595a76e4aff48b4193c8696aa5f6915755eed44a7d921b0bb99e
+  data.tar.gz: 0ce5c3df6b92a8d45ea78e93c3238c3cf2fdff88541245ad85e7e12558ca062fce5acf97a0e7fb39aff95372bc29ab0e4827bdfe4f4d2c1f30ca925f3d3b4caa

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kelvin Stinghen
+
+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,188 @@
+# silmarails
+
+Silmarails is a warehouse for templates and initial configurations for
+brand new rails project with the minimum needed for a quick development
+environment.
+
+## Pre requisites
+
+So, there is no explicit pre requisite to install this gem and use it in your
+rails project. But I actually recommend to be running with `rails ~> 4.2`,
+`ruby ~> 2.2`, `postgres` (any version) aaaaaaand, if you are creating your
+project now, to create it with the following command:
+
+```bash
+rails new my_project -T -d postgresql
+```
+
+That's it!
+
+## Install
+
+To intall this project, first, you need to add the following to your Gemfile:
+
+```ruby
+gem 'silmarails'
+gem 'kaminari'
+gem 'responders'
+gem 'simple_form'
+
+group :test do
+  gem "rspec"
+  gem "rspec-rails"
+  gem "capybara"
+  gem "database_cleaner"
+  gem 'factory_girl_rails'
+end
+
+source 'https://rails-assets.org' do
+  gem 'rails-assets-bootstrap'
+end
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+The other gems are not hard dependencies, but we have some templates defined
+that need them to work correctly, please check their installation guides
+individually. If you are not so interested in reading everyone, here comes a
+list of commands you'll probably need to execute:
+
+```bash
+rails g kaminari:config
+rails g kaminari:views bootstrap3
+rails g responders:install
+rails g simple_form:install --bootstrap
+rails g rspec:install
+```
+
+And finally:
+
+```bash
+rails g silmarails:install
+```
+
+This will copy all the default templates into your rails project, and may have
+conflicts with other gems. If so, just diff them and choose which one you
+prefer.
+
+It's important to remember that this needs to be recopied everytime there is a
+update on them.
+
+## How to update
+
+Well, that's a long story. Depends of course on how many things are you updating
+at once, but I would recommend update all of them separetedly. So:
+
+```bash
+bundle update silmarails
+```
+
+After that, you'll be able to just:
+
+
+```bash
+rails g silmarails:install
+```
+
+This, of course, can have changes dependeding on which is the update and take
+attention to your changes to the templates you've copied. Choose wisely if you
+want or not the new version. :stuck_out_and_tongue:
+
+## Recommended configuration
+
+Follows some recommended configuration for your application if you are using
+silmarails:
+
+```
+<app/assets/stylesheets/application.css>
+# add the following lines to ignore the scaffolds file and import the needed
+# bootstrap
+ *= stub scaffolds
+ *= require bootstrap
+
+<app/assets/javascripts/application.js>
+# add the following lines to import the needed bootstrap
+//= require bootstrap
+//= require magic_view
+
+# then, at the end of file, add the following line to init the magic_view code
+//= require magic_view/init
+
+<config/application.rb>
+# add the following lines to configure the generators properly
+    config.generators do |g|
+      g.test_framework :rspec,
+        fixtures: true,
+        model_specs: false,
+        helper_specs: false
+      g.fixture_replacement :factory_girl
+      g.factory_girl dir: "spec/factories"
+    end
+
+<spec/rails_helper.rb>
+# uncomment the following line to require the needed support files (one of them
+# is copied on the silmarails installations)
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# then change the value of the following config to false (the raise of the code below
+# is granting this will be always that way and explaining why it's needed, but
+# I'm warning you one more tim: DO THIS AND DON'T REMOVE THAT RAISE!!!!!!)
+  config.use_transactional_fixtures = false
+
+# and finally add the following lines to configure the database cleaner for your
+# rspec tests (put them inside the
+  config.before(:suite) do
+    # don't remove this raise for the sake of God!!!
+    if config.use_transactional_fixtures?
+      raise(<<-MSG)
+        Delete line `config.use_transactional_fixtures = true` from rails_helper.rb
+        (or set it to false) to prevent uncommitted transactions being used in
+        JavaScript-dependent specs.
+
+        During testing, the app-under-test that the browser driver connects to
+        uses a different database connection to the database connection used by
+        the spec. The app's database connection would not be able to access
+        uncommitted transaction data setup over the spec's database connection.
+      MSG
+    end
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, type: :feature) do
+    # :rack_test driver's Rack app under test shares database connection
+    # with the specs, so continue to use transaction strategy for speed.
+    driver_shares_db_connection_with_specs = Capybara.current_driver == :rack_test
+
+    unless driver_shares_db_connection_with_specs
+      # Driver is probably for an external browser with an app
+      # under test that does *not* share a database connection with the
+      # specs, so use truncation strategy.
+      DatabaseCleaner.strategy = :truncation
+    end
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.append_after(:each) do
+    DatabaseCleaner.clean
+  end
+```
+
+## TODO
+
+- [ ] Make the install generator to configure the project with the above
+recommended configuration
+- [ ] Create a way to choose which frameworks and helpers to include when
+installing, aaand copy the correct templates and files according on which were
+selected, which not
+

data/Rakefile

@@ -0,0 +1,57 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Silmarails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+namespace :templates do
+  # desc "Copy all the templates from rspec to the application directory for customization. Already existing local copies will be overwritten"
+  task :rspec do
+    generators_lib = File.join(Gem.loaded_specs["rspec-rails"].full_gem_path, "lib/generators")
+    project_templates = "#{Rails.root}/lib/templates"
+
+    default_templates = { "rspec" => %w{controller helper integration mailer model observer scaffold view} }
+
+    default_templates.each do |type, names|
+      local_template_type_dir = File.join(project_templates, type)
+      FileUtils.mkdir_p local_template_type_dir
+
+      names.each do |name|
+        dst_name = File.join(local_template_type_dir, name)
+        src_name = File.join(generators_lib, type, name, "templates")
+        FileUtils.cp_r src_name, dst_name
+      end
+    end
+  end
+end

data/app/assets/javascripts/magic_view.coffee

@@ -0,0 +1,4 @@
+class window.MagicView
+  render: ->
+  cleanup: ->
+

data/app/assets/javascripts/magic_view/init.coffee

@@ -0,0 +1,25 @@
+pageLoad = ->
+  actionClassName = $('body').data('action-view')
+  window.currentView = try
+    eval("new #{actionClassName}()")
+  catch error
+    controllerClassName = $('body').data('controller-view')
+    window.currentView = try
+      eval("new #{controllerClassName}()")
+    catch error
+      new MagicView()
+  window.currentView.render()
+
+$ ->
+  pageLoad()
+
+  # turbolinks
+  $(document).on 'page:load', pageLoad
+  $(document).on 'page:before-change', ->
+    window.currentView.cleanup()
+    true
+  $(document).on 'page:restore', ->
+    window.currentView.cleanup()
+    pageLoad()
+    true
+

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/generators/silmarails/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Copy all the overrided templates by silmarails
+
+Example:
+    rails generate silmarails:install
+
+    This will create: a lot of template files for a lot of generators
+

data/lib/generators/silmarails/install/files/spec/support/silmarails.rb

@@ -0,0 +1,33 @@
+module ActiveRecord
+  class Base
+    # this method returns the attributes to use on controller tests
+    def test_attributes
+      attributes.delete_if do |key, value|
+        ["id", "created_at", "updated_at"].include? key
+      end
+    end
+  end
+end
+
+def create_session(user = nil)
+  # You'll probably need to do something like this:
+  #
+  # controller.sign_in(user || FactoryGirl.create(:user))
+  #
+  # Or if you are using devise:
+  #
+  # sign_in(user || FactoryGirl.create(:user))
+  #
+  # If you don't need a user logged in, just leave this method as it is now
+end
+
+def valid_session_hash(user = nil)
+  # You'll probably need to do something like this:
+  #
+  # user ||= FactoryGirl.create(:user)
+  # {user_id: user.id}
+  #
+  # If you don't need a user logged in, just leave this method as it is now
+  {}
+end
+

data/lib/generators/silmarails/install/files/templates/active_record/model/model.rb

@@ -0,0 +1,22 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %><%= ', required: true' if attribute.required? %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+<%
+  attributes_to_show = attributes.reject(&:password_digest?)
+  title_attribute = attributes_to_show.find do |attr|
+    ["name", "title"].include? attr.name
+  end || attributes_to_show.first
+-%>
+<% if title_attribute.present? -%>
+  def to_title
+    <%= title_attribute.name %>
+  end
+<% end -%>
+end
+<% end -%>
+

data/lib/generators/silmarails/install/files/templates/coffee/assets/javascript.coffee

@@ -0,0 +1,11 @@
+class window.<%= class_name %>View extends MagicView
+  render: ->
+    # override this method and initialize/bind your things for the index page
+    # but don't forget to always call super
+    super
+
+  cleanup: ->
+    # everything you initialize/bind on render, rather destroy/unbind in this
+    # method, and don't forget the super
+    super
+