RubyGems - chr - Versions diffs - 0.5.7 → 0.5.8 - Mend

chr 0.5.7 → 0.5.8

Files changed (55) hide show

checksums.yaml +4 -4
data/.scss-style.yml +3 -3
data/{LICENSE → LICENSE.md} +0 -0
data/README.md +24 -10
data/app/assets/javascripts/chr/list_tabs.coffee +1 -2
data/app/assets/javascripts/chr/view_tabs.coffee +7 -6
data/app/assets/stylesheets/chr/layout.scss +15 -2
data/app/assets/stylesheets/chr/themes/basic.scss +8 -16
data/chr.gemspec +33 -34
data/lib/chr.rb +9 -12
data/lib/chr/version.rb +1 -1
metadata +8 -51
data/app/assets/javascripts/vendor/slip.js +0 -804
data/bin/chr +0 -13
data/docs/bootstrap.md +0 -23
data/docs/demo.png +0 -0
data/docs/notes.md +0 -3
data/docs/rails.md +0 -233
data/lib/chr/app_builder.rb +0 -378
data/lib/chr/generators/app_generator.rb +0 -211
data/lib/generators/chr/controller_generator.rb +0 -18
data/templates/Gemfile.erb +0 -41
data/templates/Procfile +0 -1
data/templates/README.md.erb +0 -45
data/templates/_analytics.html.erb +0 -1
data/templates/_flashes.html.erb +0 -7
data/templates/_javascript.html.erb +0 -5
data/templates/application.coffee +0 -2
data/templates/application.scss +0 -1
data/templates/application.yml +0 -6
data/templates/application_gitignore +0 -15
data/templates/application_layout.html.erb.erb +0 -17
data/templates/bin_setup.erb +0 -35
data/templates/body_class_helper.rb +0 -15
data/templates/bundler_audit.rake +0 -12
data/templates/carrierwave.rb +0 -21
data/templates/character_admin.coffee.erb +0 -38
data/templates/character_admin.scss +0 -14
data/templates/character_admin_index.html.erb +0 -5
data/templates/character_admin_layout.html.erb.erb +0 -21
data/templates/character_base_controller.rb +0 -14
data/templates/dev.rake +0 -12
data/templates/devise_overrides_passwords_controller.rb +0 -11
data/templates/devise_overrides_passwords_edit.html.erb +0 -31
data/templates/devise_overrides_passwords_new.html.erb +0 -19
data/templates/devise_overrides_sessions_controller.rb +0 -20
data/templates/devise_overrides_sessions_new.html.erb +0 -29
data/templates/errors.rb +0 -34
data/templates/json_encoding.rb +0 -1
data/templates/puma.rb +0 -18
data/templates/routes.rb +0 -86
data/templates/sample.env +0 -6
data/templates/secrets.yml +0 -14
data/templates/smtp.rb +0 -9
data/templates/staging.rb +0 -5

data/bin/chr DELETED

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-require 'pathname'
-source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
-$LOAD_PATH << source_path
-require 'chr'
-templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
-Chr::AppGenerator.source_root templates_root
-Chr::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
-Chr::AppGenerator.start

data/docs/bootstrap.md DELETED

@@ -1,23 +0,0 @@
-# Character
-## Bootstrap Data
-Bootstrapped data configuration example with disabled item updates and pagination:
-```coffee
-postsConfig = (data) ->
-  itemTitleField:     'title'
-  disableUpdateItems: true
-  objects:            data.posts
-  arrayStore: new RailsArrayStore({
-    resource:    'post'
-    path:        '/admin/posts'
-    sortBy:      'title'
-    pagination:  false
-  })
-  formSchema:
-    title: { type: 'string' }
-    body:  { type: 'text'   }
-```
-```disableUpdateItems``` — do not update items in the list while navigation, ```objects``` — provides initial (bootstrapped) array of objects to be added to the list, ```pagination``` — disable pagination for list. If attached as modules root list, you can access store data with: ```chr.modules.posts.arrayStore.data()```.

data/docs/demo.png DELETED

Binary file

data/docs/notes.md DELETED

@@ -1,3 +0,0 @@
-# Notes
-1. Consider replace ```slip.js``` with [sortable.js](https://github.com/RubaXa/Sortable)

data/docs/rails.md DELETED

@@ -1,233 +0,0 @@
-# Character
-## Rails Setup
-An example of admin implementation setup for [Rails](https://github.com/rails/rails) app that uses [Mongoid](https://github.com/mongoid/mongoid) stack.
-### Gems
-Add to following gems to ```Gemfile```:
-    gem "devise"
-    gem "mongosteen"
-    gem "chr"
-This example uses ```devise``` for admins authentication.
-### Admin authentication
-Start with running [devise](https://github.com/plataformatec/devise) generator:
-    rails generate devise:install
-Setup ```Admin``` model with devise generator:
-    rails generate devise admin
-Here is an example of basic ```app/models/admin.rb``` model that provides email/password authentication:
-```ruby
-class Admin
-  include Mongoid::Document
-  include Mongoid::Timestamps
-  include Mongoid::SerializableId
-  devise :database_authenticatable,
-         :rememberable,
-         :authentication_keys => [ :email ]
-  ## Database authenticatable
-  field :email,              type: String, default: ""
-  field :encrypted_password, type: String, default: ""
-  ## Rememberable
-  field :remember_created_at, type: Time
-end
-```
-When models are ready, setup controllers, views and configure routes.
-Base admin controller ```app/controllers/admin/base_controller.rb``` looks like this:
-```ruby
-class Admin::BaseController < ActionController::Base
-  protect_from_forgery
-  if Rails.env.production?
-    before_action :authenticate_admin!
-  end
-  def index
-    render '/admin/index', layout: 'admin'
-  end
-  def bootstrap_data
-    render json: {}
-  end
-end
-```
-Notes on code above:
-  1. Authentication is not required when running in development or testing environment;
-  2. Need to setup ```index``` view and ```admin``` layout to render admin app;
-  3. ```bootstrap_data``` is a placeholder for objects that might be required to be loaded when app starts.
-Devise would require a custom ```SessionController``` implementation in ```app/controllers/admin/devise_overrides/session_controller.rb```. ```SessionController``` sets ```admin``` layout to be used for devise views rendering.
-```ruby
-class Admin::DeviseOverrides::SessionsController < Devise::SessionsController
-  layout 'admin'
-end
-```
-Admin app layout ```app/views/layouts/admin.html.erb```:
-```erb
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no">
-    <meta name="apple-mobile-web-app-capable" content="yes">
-    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
-    <title>Admin</title>
-    <%= csrf_meta_tags %>
-    <%= stylesheet_link_tag :admin, media: "all" %>
-  </head>
-  <%= yield %>
-</html>
-```
-Admin index view ```app/views/admin/index.html.erb```:
-```erb
-<body class='loading'>
-  <% admin_email = Rails.env.production? ? current_admin.email : 'developer@example.com' %>
-  <%= link_to 'Sign Out', destroy_admin_session_path, 'data-admin-email' => admin_email,
-               method: :delete,
-               style: 'display:none;', class:  'menu-logout' %>
-</body>
-<%= javascript_include_tag :admin %>
-```
-New session view for devise ```app/views/admin/devise_overrides/sessions/new.html.erb```:
-```erb
-<body class='sign-in'>
-  <h2>Sign In</h2>
-  <%= simple_form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
-    <% if alert %>
-      <p class="error"><%= alert.gsub('username', 'email').gsub('or sign up', '') %></p>
-    <% end %>
-    <div class="form-inputs">
-      <%= f.input :email,    required: true, autofocus: true %>
-      <%= f.input :password, required: true %>
-      <%= f.input :remember_me, as: :boolean if devise_mapping.rememberable? %>
-    </div>
-    <div class="form-actions">
-      <%= f.button :submit, "Sign In" %>
-    </div>
-  <% end %>
-</body>
-```
-Now connect admin and devise in ```config/routes.rb``` with:
-```ruby
-devise_for :admins, path: "admin", controllers: { sessions: "admin/devise_overrides/sessions" }
-namespace :admin do
-  get '/'               => 'base#index'
-  get '/bootstrap.json' => 'base#bootstrap_data'
-end
-```
-### Character setup
-Three pieces to be configured here.
-**First**: create ```app/assets/javascripts/admin.coffee``` with empty ```modules``` configuration:
-```coffee
-#= require jquery
-#= require jquery_ujs
-#= require chr
-$ ->
-  $.get '/admin/bootstrap.json', (response) ->
-    config =
-      modules: {}
-    $('body').removeClass('loading')
-    chr.start(config)
-    # append signout button to the end of sidebar menu
-    $('a[data-method=delete]').appendTo(".sidebar .menu").show()
-```
-**Second**: create foundation for style customization in ```app/assets/stylesheets/admin.scss```:
-```scss
-@charset "utf-8";
-@import "normalize-rails";
-@import "chr";
-@import "admin/signin";
-```
-Last import in the code above is optional. But here is a default source for it as well ```app/assets/stylesheets/admin/chr/_signin.scss```:
-```scss
-.sign-in {
-  margin: 2em; max-width: 18em;
-  h2 { text-transform: uppercase; color: $black; }
-  input { @include no-outline; }
-  label { color: $black; }
-  .input { margin-bottom: .75em; }
-  .input input[type=checkbox] { margin-right: .5em; }
-  .input input.email, .input input.password {
-    float: right; margin: -2px 0 0; width: 12em;
-    border: 0; border-bottom: 1px solid $contrastColor;
-  }
-  .input.boolean { margin-top: 1.25em; }
-  .form-actions input {
-    width: 100%; padding: 1em 2em; margin-top: .75em;
-    color: $white; background-color: $positiveColor; border: 0;
-  }
-}
-```
-**Third**: make sure admin assets are precompiled on production, include ```admin.js``` and ```admin.css``` in ```config/initializers/assets.rb```:
-```ruby
-Rails.application.config.assets.precompile += %w( admin.js admin.css )
-```
-At this point initial setup for admin app is finished and it could be accessed via: ```localhost:3000/admin```.
-### Add models
-To be continued...

data/lib/chr/app_builder.rb DELETED

@@ -1,378 +0,0 @@
-module Chr
-  class AppBuilder < Rails::AppBuilder
-    def readme
-      template 'README.md.erb', 'README.md'
-    end
-    def replace_gemfile
-      remove_file 'Gemfile'
-      template 'Gemfile.erb', 'Gemfile'
-    end
-    def set_ruby_to_version_being_used
-      create_file '.ruby-version', "#{Chr::RUBY_VERSION}\n"
-    end
-    def raise_on_delivery_errors
-      replace_in_file 'config/environments/development.rb',
-        'raise_delivery_errors = false', 'raise_delivery_errors = true'
-    end
-    def raise_on_unpermitted_parameters
-      config = <<-RUBY
-    config.action_controller.action_on_unpermitted_parameters = :raise
-      RUBY
-      inject_into_class "config/application.rb", "Application", config
-    end
-    def provide_setup_script
-      template "bin_setup.erb", "bin/setup", port_number: port, force: true
-      run "chmod a+x bin/setup"
-    end
-    def provide_dev_prime_task
-      copy_file 'dev.rake', 'lib/tasks/dev.rake'
-    end
-    def configure_generators
-      config = <<-RUBY
-      config.generators do |generate|
-        generate.helper false
-        generate.javascript_engine false
-        generate.stylesheets false
-      end
-      RUBY
-      inject_into_class 'config/application.rb', 'Application', config
-    end
-    def configure_smtp
-      copy_file 'smtp.rb', 'config/smtp.rb'
-      prepend_file 'config/environments/production.rb',
-        %{require Rails.root.join("config/smtp")\n}
-      config = <<-RUBY
-  config.action_mailer.delivery_method = :smtp
-  config.action_mailer.smtp_settings = SMTP_SETTINGS
-      RUBY
-      inject_into_file 'config/environments/production.rb', config,
-        :after => 'config.action_mailer.raise_delivery_errors = false'
-    end
-    def configure_rack_timeout
-      rack_timeout_config = <<-RUBY
-  Rack::Timeout.timeout = (ENV["RACK_TIMEOUT"] || 10).to_i
-      RUBY
-      append_file "config/environments/production.rb", rack_timeout_config
-    end
-    def enable_rack_canonical_host
-      config = <<-RUBY
-  # Ensure requests are only served from one, canonical host name
-  config.middleware.use Rack::CanonicalHost, ENV.fetch("HOST")
-      RUBY
-      inject_into_file(
-        "config/environments/production.rb",
-        config,
-        after: serve_static_files_line
-      )
-    end
-    def enable_rack_deflater
-      config = <<-RUBY
-  # Enable deflate / gzip compression of controller-generated responses
-  config.middleware.use Rack::Deflater
-      RUBY
-      inject_into_file(
-        "config/environments/production.rb",
-        config,
-        after: serve_static_files_line
-      )
-    end
-    def setup_asset_host
-      replace_in_file 'config/environments/production.rb',
-        "# config.action_controller.asset_host = 'http://assets.example.com'",
-        'config.action_controller.asset_host = ENV.fetch("ASSET_HOST")'
-      replace_in_file 'config/initializers/assets.rb',
-        "config.assets.version = '1.0'",
-        'config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")'
-      inject_into_file(
-        "config/environments/production.rb",
-        '  config.static_cache_control = "public, max-age=#{1.year.to_i}"',
-        after: serve_static_files_line
-      )
-    end
-    def setup_staging_environment
-      staging_file = 'config/environments/staging.rb'
-      copy_file 'staging.rb', staging_file
-      config = <<-RUBY
-  Rails.application.configure do
-  # ...
-  end
-      RUBY
-      append_file staging_file, config
-    end
-    def setup_secret_token
-      template 'secrets.yml', 'config/secrets.yml', force: true
-    end
-    def create_partials_directory
-      empty_directory 'app/views/application'
-    end
-    def create_shared_analytics
-      copy_file '_analytics.html.erb', 'app/views/application/_analytics.html.erb'
-    end
-    def create_shared_flashes
-      copy_file '_flashes.html.erb', 'app/views/application/_flashes.html.erb'
-    end
-    def create_shared_javascripts
-      copy_file '_javascript.html.erb', 'app/views/application/_javascript.html.erb'
-    end
-    def create_application_layout
-      template 'application_layout.html.erb.erb',
-        'app/views/layouts/application.html.erb',
-        force: true
-    end
-    def create_body_class_helper
-      copy_file 'body_class_helper.rb', 'app/helpers/body_class_helper.rb'
-    end
-    def configure_action_mailer
-      action_mailer_host "development", %{"localhost:#{ port }"}
-      action_mailer_host "test",        %{ "www.example.com" }
-      action_mailer_host "staging",     %{ ENV.fetch("HOST") }
-      action_mailer_host "production",  %{ ENV.fetch("HOST") }
-      configure_environment "production", 'config.action_mailer.asset_host = "http://#{ ENV.fetch("ASSET_HOST") }"'
-    end
-    def configure_puma
-      copy_file "puma.rb", "config/puma.rb"
-    end
-    def setup_foreman
-      copy_file 'sample.env', '.sample.env'
-      copy_file 'Procfile', 'Procfile'
-    end
-    def setup_stylesheets
-      remove_file "app/assets/javascripts/application.js"
-      copy_file "application.coffee",
-                "app/assets/javascripts/application.coffee"
-    end
-    def setup_javascripts
-      remove_file "app/assets/stylesheets/application.css"
-      copy_file "application.scss",
-                "app/assets/stylesheets/application.scss"
-    end
-    def copy_miscellaneous_files
-      copy_file "errors.rb", "config/initializers/errors.rb"
-      copy_file "json_encoding.rb", "config/initializers/json_encoding.rb"
-    end
-    def customize_error_pages
-      meta_tags =<<-EOS
-  <meta charset="utf-8" />
-  <meta name="ROBOTS" content="NOODP" />
-  <meta name="viewport" content="initial-scale=1" />
-      EOS
-      %w(500 404 422).each do |page|
-        inject_into_file "public/#{page}.html", meta_tags, after: "<head>\n"
-        replace_in_file "public/#{page}.html", /<!--.+-->\n/, ''
-      end
-    end
-    def setup_devise
-      generate 'devise:install'
-      replace_in_file 'config/initializers/devise.rb',
-        '# config.scoped_views = false',
-        'config.scoped_views = true'
-      replace_in_file 'config/initializers/devise.rb',
-        '# config.sign_out_all_scopes = true',
-        'config.sign_out_all_scopes = false'
-    end
-    def setup_character_routes
-      remove_file 'config/routes.rb'
-      copy_file 'routes.rb', 'config/routes.rb'
-    end
-    def setup_character_base_controller
-      copy_file 'character_base_controller.rb', 'app/controllers/admin/base_controller.rb'
-    end
-    def configure_devise_for_character
-      copy_file 'devise_overrides_passwords_controller.rb', 'app/controllers/admin/devise_overrides/passwords_controller.rb'
-      copy_file 'devise_overrides_sessions_controller.rb',  'app/controllers/admin/devise_overrides/sessions_controller.rb'
-      copy_file 'devise_overrides_passwords_edit.html.erb', 'app/views/admin/devise_overrides/passwords/edit.html.erb'
-      copy_file 'devise_overrides_passwords_new.html.erb',  'app/views/admin/devise_overrides/passwords/new.html.erb'
-      copy_file 'devise_overrides_sessions_new.html.erb',   'app/views/admin/devise_overrides/sessions/new.html.erb'
-    end
-    def setup_character_views
-      template 'character_admin_layout.html.erb.erb',
-        'app/views/layouts/admin.html.erb',
-        force: true
-      copy_file 'character_admin_index.html.erb',  'app/views/admin/index.html.erb'
-    end
-    def setup_character_stylesheets
-      template 'character_admin.coffee.erb', 'app/assets/javascripts/admin.coffee'
-    end
-    def setup_character_javascripts
-      copy_file 'character_admin.scss', 'app/assets/stylesheets/admin.scss'
-    end
-    def setup_character_assets
-      replace_in_file 'config/initializers/assets.rb',
-        "# Rails.application.config.assets.precompile += %w( search.js )",
-        'Rails.application.config.assets.precompile += %w( admin.js admin.css )'
-    end
-    def setup_carrierwave
-      copy_file "carrierwave.rb", "config/initializers/carrierwave.rb"
-    end
-    def init_git
-      run 'git init'
-    end
-    def gitignore_files
-      remove_file '.gitignore'
-      template 'application_gitignore', '.gitignore'
-    end
-    def initialize_mongoid
-      generate 'mongoid:config'
-      append_file "config/mongoid.yml", """\nproduction:
-  clients:
-    default:
-      uri: <%= ENV['MONGODB_URI'] %>"""
-    end
-    def setup_bundler_audit
-      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
-      append_file "Rakefile", %{\ntask default: "bundler:audit"\n}
-    end
-    def setup_spring
-      bundle_command "exec spring binstub --all"
-    end
-    private
-      def port
-        3000
-      end
-      def serve_static_files_line
-        "config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?\n"
-      end
-      def replace_in_file(relative_path, find, replace)
-        path     = File.join(destination_root, relative_path)
-        contents = IO.read(path)
-        unless contents.gsub!(find, replace)
-          raise "#{ find.inspect } not found in #{ relative_path }"
-        end
-        File.open(path, "w") { |file| file.write(contents) }
-      end
-      def action_mailer_host(rails_env, host)
-        config = "config.action_mailer.default_url_options = { host: #{host} }"
-        configure_environment(rails_env, config)
-      end
-      def configure_environment(rails_env, config)
-        inject_into_file(
-          "config/environments/#{rails_env}.rb",
-          "\n\n  #{config}",
-          before: "\nend"
-        )
-      end
-  end
-end