chr 0.3.5 → 0.4.9

data/app/assets/stylesheets/chr/{_settings.scss → settings.scss}

@@ -8,7 +8,7 @@ $contrastColor:  rgb(230,230,230) !default;
 $white:          rgb(255,255,255) !default;
 $black:          #333 !default;
 
-$fontFamily: 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif;
+$fontFamily: 'Helvetica Neue', Helvetica, Arial, 'Lucida Grande', sans-serif !default;
 
 /* Layouts ----------------------------------------------------------------- */
 $tablet:  "screen and (min-width:768px)";

data/bin/chr

@@ -0,0 +1,13 @@
+#!/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/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env sh
+
+# Run this script immediately after cloning the codebase.
+
+# Exit if any subcommand fails
+set -e
+
+# Set up Ruby dependencies via Bundler
+bundle install
+
+# Add binstubs to PATH in ~/.zshenv like this:
+#   export PATH=".git/safe/../../bin:$PATH"
+# mkdir -p .git/safe

data/chr.gemspec

@@ -1,32 +1,52 @@
-# coding: utf-8
+# -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
 require 'chr/version'
+require 'date'
 
 Gem::Specification.new do |s|
-  s.name        = 'chr'
-  s.version     = Chr::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Alexander Kravets']
-  s.email       = 'alex@slatestudio.com'
-  s.license     = 'MIT'
-  s.homepage    = 'http://slatestudio.com'
-  s.summary     = 'Powerful responsive javascript CMS for apps'
+  s.required_ruby_version = ">= #{Chr::RUBY_VERSION}"
+
+  s.authors = [ 'Alexander Kravets', 'Denis Popov', 'Roman Brazhnyk' ]
+  s.email   = 'alex@slatestudio.com'
+  s.date    = Date.today.strftime('%Y-%m-%d')
+
   s.description = <<-DESC
 Character is a library written in CoffeeScript with a help of jQuery that allows to
 build data management web applications in a fast and flexible way, e.g. CMS, news reader,
 email client etc. It's responsive by default and designed to be data source independent.
   DESC
 
-  s.rubyforge_project = 'chr'
-
+  s.name          = 'chr'
+  s.summary       = 'Powerful responsive javascript CMS for apps.'
+  s.homepage      = 'http://github.com/slate-studio/chr'
+  s.license       = 'MIT'
   s.files         = `git ls-files`.split("\n")
-  s.require_paths = ['lib']
-
-  s.add_dependency('bourbon',         '>= 3.2')
-  s.add_dependency('coffee-rails',    '>= 4.0')
-  s.add_dependency('normalize-rails', '>= 3.0')
-end
-
-
-
-
+  s.executables   = [ 'chr' ]
+  s.require_paths = [ 'lib' ]
+  s.version       = Chr::VERSION
+  s.platform      = Gem::Platform::RUBY
+
+  s.add_dependency 'rails',    Chr::RAILS_VERSION
+  s.add_dependency 'coffee-rails',    '>= 4.0'
+  s.add_dependency 'jquery-rails'
+  s.add_dependency 'sass-rails'
+  s.add_dependency 'normalize-rails', '>= 3.0'
+  s.add_dependency 'bourbon',         '>= 3.2'
+  s.add_dependency 'formagic',        '>= 0.2.6'
+
+  # tests
+  s.add_development_dependency 'mongosteen', '~> 0.1.8'
+  s.add_development_dependency 'ants',       '~> 0.2.1'
+  s.add_development_dependency 'loft',       '~> 0.2.3'
+
+  s.add_development_dependency 'faker'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'uglifier',         '>= 1.3.0'
+  s.add_development_dependency 'database_cleaner', '1.0.1'
+  s.add_development_dependency 'factory_girl_rails'
+  s.add_development_dependency 'capybara-webkit'
+  s.add_development_dependency 'capybara-screenshot'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'minitest-reporters'
+
+end

data/docs/tests.md

@@ -0,0 +1,64 @@
+## Running Tests
+
+    rake test
+
+#### Covered configs:
+
+  # disableNewItems:   - do not show new item button in list header
+  # showWithParent:    - show list on a aside from parent
+  # disableFormCache:  - do disable cache
+  # searchable:        - add search button
+  # reorderable:       - permit reorder items
+  # disableDelete:     - do not add delete button below the form
+  # disableSave:       - do not add save button in header    
+  # fullsizeView:      - use fullsize layout in desktop mode
+  # urlParams:        Article.sport_articles  - additional parameter to be included into request
+  # sortReverse:       - reverse objects sorting (descending order), default: false
+  # pagination:        - add this, if there are many objects (add extra test)
+
+  # uploaderImage:     - run tests, for checking uploader
+
+
+#### Tests structure:
+
+`test/integration/..` - Each file it's presentation of Module with different config, for test all functionallity
+`test/support/character_front_end` - Main module with logic and helper methods, depending of config running appropriate set of tests.
+
+**Modules with tests:**
+
+    test/support/chr/...
+    test/support/stores/...
+
+
+#### Tests functions:
+
+`show_item(factory_name, list_of_modules)`  Generate module, item and item_form
+`chage_title(factory_name, class_name, list_of_modules)` Change fileds of items, also changing Model
+`add_item(factory_name, class_name, list_of_modules)`  Create new object
+`delete_item(factory_name, class_name, list_of_modules)` Delete object
+`open_item_and_close(factory_name, list_of_modules)` Render item_form and close it
+`search(factory_name, list_of_modules)` Generate search request, and check result
+`search_and_close(factory_name, class_name, list_of_modules)` Generate search result, and reset it (check, that all items visible again)
+`reorder(factory_name, class_name, list_of_modules)` Reorder objects by drag and drop (check that _position change, and rendering correct)
+`show_with_parent(factory_name, list_of_modules)` Open item with showWithParent: true, check, that there are items and parent render on one page
+`disable_new_item(factory_name, list_of_modules)` Render list without button "+"
+`disable_delete(factory_name, list_of_modules)` Render View without button "delete"
+`disable_save(factory_name, list_of_modules)` Render View without button "save"
+`fullsize_view(factory_name, list_of_modules)` Render View with fullsizeView: true
+`add_class_active(factory_name, list_of_modules)` Checking, that class active adding correctly.
+`pagination(factory_name, class_name, list_of_modules)` Render list with many items, and scrolling to the buttom (checking for coreect download new pages)
+`pagination_and_reorder(factory_name, class_name, list_of_modules)` Render list with many items, scrolling and reorder item on each page
+`click_back(factory_name, list_of_modules)` Render last one of compound modules, click button "back"
+**Checking Pagination:**
+
+    chage_position_to_end_and_check_pagination(factory_name, class_name, list_of_modules
+    chage_position_to_begin_and_check_pagination(factory_name, class_name, list_of_modules)
+    chage_position_to_middle_and_check_pagination(factory_name, class_name, list_of_modules)
+    create_first_item_and_check_pagination(factory_name, class_name, list_of_modules)
+    create_last_item_on_page_and_check_pagination(factory_name, class_name, list_of_modules)
+
+`urlParams(factory_name, class_name, list_of_modules, config)` Checking, that in generated list only items from scope (urlParams:true)
+`remove_from_scope(factory_name, class_name, list_of_modules, config)` Remove item from scope (urlParams:true)
+`sortReverse_by_position(factory_name, class_name, list_of_modules)` Checking, that list render in reverse order
+`add_image(factory_name, list_of_modules)` Upload image
+`remove_image(factory_name, list_of_modules)` Remove image

data/lib/chr.rb

@@ -1,11 +1,19 @@
-require 'normalize-rails'
+require 'chr/version'
+require 'chr/generators/app_generator'
+require 'chr/app_builder'
+
+require 'rails'
 require 'bourbon'
+require 'formagic'
+require 'jquery-rails'
+require 'coffee-rails'
+require 'sass-rails'
+require 'normalize-rails'
 
 module Chr
   if defined?(Rails) && defined?(Rails::Engine)
     class Engine < ::Rails::Engine
       require 'chr/engine'
-      require 'mongoid/character'
     end
   end
 end

data/lib/chr/app_builder.rb

@@ -0,0 +1,385 @@
+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 'development_seeds.rb', 'lib/tasks/development_seeds.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_newrelic
+      template 'newrelic.yml.erb', 'config/newrelic.yml'
+    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_asset_sync
+      copy_file 'asset_sync.rb', 'config/initializers/asset_sync.rb'
+    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
+      copy_file 'character_admin_layout.html.erb', 'app/views/layouts/admin.html.erb'
+      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:
+  sessions:
+    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
+
+
+