r4 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e4f0b657ce05f7414ac7976b530f0f0d05d49b2
+  data.tar.gz: 773801128438961f825665026bb5675f6e48de00
+SHA512:
+  metadata.gz: e2df90ae0b0fb2fb13caba20d495ee6c8d242af4e99d6e537194e348de0b885c3835399527448de2bbc5f25d5c18cfdae61dcc18e7bd5f04749990f28ad83008
+  data.tar.gz: 30a9589d879512e0f1813874db3a676897cbb37b98d36cb6c7e1df1dd7736f3a5a65fe0fccc32367650f5d48b72e856f7bd986666b35522b3a7b1662151d07b7

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+# R4
+
+This gem is used for generating default project for Timepress company. However we hope it can be useful for other users as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+It is still not in Rubygems repository. Thus this wont work for a while.
+
+You can clone project and use bundler to install gem locally with "rake install".
+
+```ruby
+gem 'r4'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install r4
+
+## Usage
+
+Gem expects config file in home directory named .r4.yml, which should contain following:
+
+```
+mysql:
+  user: 'mysql_user_name'
+  password: 'mysql_password'
+
+admin:
+  login: 'default_admin_login'
+  password: 'default_admin_password'
+  email: 'default@admin.email'
+  lastname: 'AdminLastName'
+
+notifier:
+  email: 'email@for_exception.notifier'
+
+server:
+  name: 'server_name_for_deploy_script'
+  port: 'ssh_port_number'
+  user: 'server_user_for_deploy'
+```
+
+Then you can create new application with r4 new name_of_app
+Custom installations types can be specified in 'installations' directory.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/r4/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,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "r4"
+
+# 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/r4

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'r4'
+Starter.start(ARGV)

data/bin/setup

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

data/lib/r4.rb

@@ -0,0 +1,5 @@
+require "r4/version"
+require 'r4/starter'
+module R4
+ # some code
+end

data/lib/r4/config.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+
+class Config
+
+  def self.settings
+    if File.exists? "#{ENV['HOME']}/.r4.yml"
+      YAML::load_file("#{ENV['HOME']}/.r4.yml")
+    else
+      'You need to create ~/.r4.yml file, check github for example.'
+    end
+  end
+end

data/lib/r4/installations/default.rb

@@ -0,0 +1,44 @@
+# DEFAULT SETTINGS
+copy '.ruby-version'
+apply 'recipes/gemfile.rb'
+
+copy 'config/initializers/html_helpers.rb'
+copy 'config/locales/cs.yml'
+copy 'app/assets/stylesheets/theme.css'
+copy 'app/assets/stylesheets/custom.css.scss'
+copy 'app/assets/stylesheets/timepress.css.scss'
+
+remove 'app/views/layouts/application.html.erb'
+copy 'app/views/layouts/application.html.erb'
+
+apply 'recipes/bootstrap_app.rb'
+apply 'recipes/upload_app.rb'
+gsub_file "#{@project_path}/lib/tasks/upload.rake", /PROJECT_DIR/, @project_name
+
+insert_into_file "#{@project_path}/config/application.rb",
+                 after: "class Application < Rails::Application\n" do <<-RUBY
+      config.assets.enabled = true
+      config.assets.precompile += %w()
+      config.i18n.default_locale = :cs
+      config.time_zone = 'Prague'
+RUBY
+end
+
+apply 'recipes/mysql.rb'
+apply 'recipes/rspec_generators.rb'
+apply 'recipes/exception_notification.rb'
+rake 'db:drop'
+rake 'db:create'
+
+apply 'recipes/devise.rb'
+apply 'recipes/bootstrap.rb'
+layout_file = "#{@project_path}/app/views/layouts/application.html.erb"
+remove 'app/views/layouts/application.html.erb'
+copy 'app/views/layouts/application.html.erb'
+gsub_file layout_file, 'PROJECT_NAME', @project_name
+apply 'recipes/gitignore'
+run 'git init'
+run 'git add .'
+run "git commit -a -m 'Initial commit'"
+
+rake 'app:bootstrap'

data/lib/r4/installations/testing.rb

@@ -0,0 +1,4 @@
+apply 'installations/default.rb'
+# for testing project starter
+run "rails g scaffold Article name:string body:text"
+rake "db:migrate"

data/lib/r4/odin.rb

@@ -0,0 +1,76 @@
+module Odin
+
+  def gsub filename, options={}, &block
+    puts options[:log] if options[:log]
+    fr = File.new(filename)
+    content = fr.read
+    fr.close
+    change = content.clone
+    block.call change
+    unless content==change
+      fw = File.new filename, 'w'
+      fw.write change
+      fw.close
+    end
+  end
+
+  def sub filename, mark, part, options={}
+    File.open(filename) do |f|
+      content = f.read
+      if options[:global]
+        change = content.gsub mark, part
+      else
+        change = content.sub mark, part
+      end
+      unless change==content
+        file filename, change
+      end
+    end
+  end
+
+  def content filename
+    File.open(filename).read
+  end
+
+  def concat filename, part
+    File.open(filename) do |f|
+      content = f.read
+      file filename, content + part
+    end
+  end
+
+  def file filename, content
+    File.open(filename, 'w') do |f|
+      f.write content
+    end
+  end
+
+  def cp from, to
+    system "cp #{from} #{to}"
+  end
+  def rm what
+    system "rm #{what}"
+  end
+
+  def cp_template template_dir, path
+    cp "#{template_dir}/#{path}", path
+  end
+
+  def rake task
+    system "rake #{task}"
+  end
+
+  def rails task
+    system "rails #{task}"
+  end
+
+  def git task
+    system "git #{task}"
+  end
+
+  def bundle task=''
+    system "bundle #{task}"
+  end
+
+end
+

data/lib/r4/recipes/bootstrap.rb

@@ -0,0 +1,9 @@
+add_gem 'bootstrap-generators'
+add_gem 'bootstrap-select-rails'
+add_gem 'scrollbar-rails'
+run 'bundle install'
+# TODO removing is probably not good idea when adding bootstrap to existing project
+remove 'app/views/layouts/application.html.erb'
+system "rails generate bootstrap:install"
+sub "#{@project_path}/app/views/layouts/application.html.erb", /<title>.*?<\/title>/, "<title>#{@project_label}</title>"
+sub "#{@project_path}/app/views/layouts/application.html.erb", /Project name/, @project_label

data/lib/r4/recipes/bootstrap_app.rb

@@ -0,0 +1,10 @@
+path = 'lib/tasks/bootstrap.rake'
+bootstrap_file = "#{@project_path}/#{path}"
+copy path
+
+gsub_file bootstrap_file, 'ADMIN_LOGIN', Config.settings['admin']['login']
+gsub_file bootstrap_file, 'ADMIN_PASSWORD', Config.settings['admin']['password']
+gsub_file bootstrap_file, 'ADMIN_EMAIL', Config.settings['admin']['email']
+gsub_file bootstrap_file, 'ADMIN_LASTNAME', Config.settings['admin']['lastname']
+
+

data/lib/r4/recipes/devise.rb

@@ -0,0 +1,94 @@
+
+# TODO add checking for existing devise in project
+add_gem 'devise'
+
+run 'bundle install'
+run 'rails g devise:install'
+run 'rails g devise User'
+
+insert_into_file "#{@project_path}/app/controllers/application_controller.rb",
+                 after: "class ApplicationController < ActionController::Base\n" do <<-RUBY
+    protect_from_forgery with: :exception
+    before_action :configure_permitted_parameters, if: :devise_controller?
+    before_action :authenticate_user!
+
+    protected
+
+    def configure_permitted_parameters
+      devise_parameter_sanitizer.for(:sign_in) { |u| u.permit(:login, :password, :remember_me) }
+      devise_parameter_sanitizer.for(:account_update) { |u|
+        u.permit(:password, :password_confirmation, :current_password)
+      }
+    end
+
+    def only_for_user
+      complain unless current_user
+    end
+
+    def only_for_admin
+      complain unless current_user && current_user.admin?
+    end
+
+    def complain
+      # TODO - 404 or just polite 'permissions denied'
+      raise StandardError.new 'permissions denied'
+    end
+RUBY
+end
+
+insert_into_file "#{@project_path}/app/models/user.rb",
+                 after: "class User < ActiveRecord::Base\n" do <<-RUBY
+    def display_name
+      [firstname, lastname].join(' ')
+    end
+
+RUBY
+
+end
+
+#TODO check for devise
+user_migrate_filename = Dir.glob("#{@project_path}/db/migrate/*devise_create_users.rb").first
+unless File.open(user_migrate_filename).read=~/string :login/
+  gsub_file user_migrate_filename, 't.string :email,', "t.string :login,              null: false, default: ''\n      t.string :email,"
+  gsub_file user_migrate_filename, ':encrypted_password, null: false, default: ""' do <<-RUBY
+        :encrypted_password, null: false, default: ''
+        t.string :firstname, null: false, default: ''
+        t.string :lastname, null: false, default: ''
+        t.boolean :admin, null: false, default: false
+  RUBY
+  end
+end
+
+# part for editing users and own password
+copy 'app/controllers/users_controller.rb'
+Dir.mkdir "#{@project_path}/app/views/users"
+directory 'app/views/users', "#{@project_path}/app/views/users"
+
+# different options can be used - this one is allowing admins to change passwords to other users
+# - edit_user_registration_path can be used instead - then only user can change his/her own password
+
+gsub_file "#{@project_path}/config/routes.rb", 'devise_for :users' do
+<<EOF
+  devise_for :users
+  scope "/admin" do
+    resources :users
+  end
+
+  get 'edit_password/:id' => 'users#edit_password'
+  resource :user, only: [:edit] do
+    collection do
+      patch 'update_password'
+    end
+  end
+
+  get 'edit_own_password' => 'users#edit_own_password'
+EOF
+end
+
+gsub_file "#{@project_path}/config/routes.rb", "# root 'welcome#index'" do
+  "root 'users#index'"
+end
+
+
+run 'rake app:bootstrap'
+run 'rake db:migrate'

data/lib/r4/recipes/exception_notification.rb

@@ -0,0 +1,10 @@
+add_gem 'exception_notification'
+
+run 'bundle install'
+
+config_file = "#{@project_path}/config/initializers/exception_notification.rb"
+
+run 'rails g exception_notification:install' unless File.exist? config_file
+gsub_file config_file, "\"[ERROR] \"", "\"[#{@project_label} ERROR] \""
+gsub_file config_file, "%{\"Notifier\" <notifier@example.com>},", "%{\"#{@project_label} Notifier\" #{Config.settings['notifier']['email']}},"
+gsub_file config_file, "%w{exceptions@example.com}', '%w{#{Config.settings['notifier']['email']}}"

data/lib/r4/recipes/gemfile.rb

@@ -0,0 +1,34 @@
+gemfile = "#{@project_path}/Gemfile"
+gsub_file gemfile, "gem 'sqlite3'", "gem 'mysql2', '0.3.18'"
+
+insert_into_file gemfile, after: "group :development, :test do\n" do
+  <<EOF
+  gem 'rspec-rails'
+  gem 'factory_girl_rails'
+  gem 'timecop'
+  gem 'guard-rspec'
+  gem 'spring-commands-rspec'
+EOF
+end
+
+insert_into_file gemfile, after: "group :development do\n" do
+  <<EOF
+  gem 'better_errors'
+  gem 'binding_of_caller'
+  gem 'meta_request'
+  gem 'bullet'
+EOF
+end
+
+append_to_file gemfile do
+  <<EOF
+group :test do
+  gem 'faker'
+  gem 'capybara'
+end
+
+gem 'font-awesome-rails'
+gem 'quiet_assets'
+gem 'jquery-ui-rails'
+EOF
+end

data/lib/r4/recipes/gitignore.rb

@@ -0,0 +1,8 @@
+append_to_file "#{@project_path}/.gitignore" do
+<<EOF
+/config/database.yml
+/log/*.log
+/tmp
+/db/schema.rb
+EOF
+end

data/lib/r4/recipes/install_questions.rb

@@ -0,0 +1,20 @@
+if yes? 'Do you want to prepare database config for mysql?'
+  apply 'recipes/mysql.rb'
+end
+
+if yes? 'Do you want to add rspec generators to application.rb?'
+  apply 'recipes/rspec_generators.rb'
+end
+
+if yes? 'Do you want to add exception notification?'
+  apply 'recipes/exception_notification.rb'
+end
+
+if yes? 'do you want to drop and create a database?'
+  rake 'db:drop'
+  rake 'db:create'
+end
+
+if yes? 'Do you want to add devise to project?'
+  apply 'recipes/devise.rb'
+end