atomic_cms 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f86fcb1ed12c234e15e219684b25b77a5775bee
-  data.tar.gz: 76fc3306cd7814413f8813963282a15816659c97
+  metadata.gz: 2ef68fd2934dc40720fe78c309ede067c8f48098
+  data.tar.gz: 13ba7932c24ace6e795b82cf880d3df696654009
 SHA512:
-  metadata.gz: 68339f90980248a485daeb22ed8974c084ce8917923483dae652c96b0e42df8a7ff0406e2ae01edfc27d1707939eaae8cdc2e03086d275a34d9869fb711d3012
-  data.tar.gz: 0ec70c6c1c2d0258cfe8d8db8f4321f8f322f82971bee5b59c8f1e472b0e91fd02a52cfe02fc1bfba1e5ce4462780739e71a640e47b9a31d1ce334a58a5e6cd6
+  metadata.gz: 22966be2c77229934a7849521b2a7334dd6e077320530e450d7c06fda88989fee98fa1007d98938f38bc154f5e5dc6435131abdbaa02b7d96f489a462020cd1e
+  data.tar.gz: 96e7f3e00c584006ccd308e3100e3b900c6b11f0672cf04eb708c334ec8fee4a6918040d6a2ec810d941472bb1c0969e1fd1ef36d293015b87626b68f0989e8d

data/.eslintrc

@@ -0,0 +1,16 @@
+{
+  'env': {
+    'browser': true,
+    'node': true
+  },
+  'globals': {
+    'window': true,
+    'document': true,
+    'jQuery': true,
+    '$': true,
+    'angular': true
+  },
+  'rules': {
+    'quotes': [2, 'single', 'avoid-escape']
+  }
+}

data/.gitignore

@@ -0,0 +1,11 @@
+.bundle/
+log/*.log
+pkg/
+*.gem
+*.DS_Store
+*.keep
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,243 @@
+PATH
+  remote: .
+  specs:
+    atomic_cms (0.0.1)
+      activeadmin (= 1.0.0.pre2)
+      angularjs-rails (~> 1.3, < 1.4)
+      atomic_assets (~> 0.0.4)
+      jquery-rails (~> 4.0, >= 4.0.3)
+      paperclip (~> 4.3)
+      rails (~> 4.2)
+      redcarpet (~> 3.3)
+      slim-rails (~> 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.4)
+      actionview (= 4.2.4)
+      activesupport (= 4.2.4)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activeadmin (1.0.0.pre2)
+      arbre (~> 1.0, >= 1.0.2)
+      bourbon
+      coffee-rails
+      formtastic (~> 3.1)
+      formtastic_i18n
+      inherited_resources (~> 1.6)
+      jquery-rails
+      jquery-ui-rails
+      kaminari (~> 0.15)
+      rails (>= 3.2, < 5.0)
+      ransack (~> 1.3)
+      sass-rails
+    activejob (4.2.4)
+      activesupport (= 4.2.4)
+      globalid (>= 0.3.0)
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    angularjs-rails (1.3.15)
+    arbre (1.0.3)
+      activesupport (>= 3.0.0)
+    arel (6.0.3)
+    atomic_assets (0.0.4)
+      draper (~> 2.1)
+    bourbon (4.2.5)
+      sass (~> 3.4)
+      thor (~> 0.19)
+    builder (3.2.2)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    cocaine (0.5.7)
+      climate_control (>= 0.0.3, < 1.0)
+    coffee-rails (4.1.0)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1.1)
+    diff-lcs (1.2.5)
+    draper (2.1.0)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      request_store (~> 1.0)
+    erubis (2.7.0)
+    execjs (2.6.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    formtastic (3.1.3)
+      actionpack (>= 3.2.13)
+    formtastic_i18n (0.4.1)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    has_scope (0.6.0)
+      actionpack (>= 3.2, < 5)
+      activesupport (>= 3.2, < 5)
+    i18n (0.7.0)
+    inherited_resources (1.6.0)
+      actionpack (>= 3.2, < 5)
+      has_scope (~> 0.6.0.rc)
+      railties (>= 3.2, < 5)
+      responders
+    jquery-rails (4.0.5)
+      rails-dom-testing (~> 1.0)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    jquery-ui-rails (5.0.5)
+      railties (>= 3.2.16)
+    json (1.8.3)
+    kaminari (0.16.3)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.6.2)
+    mimemagic (0.3.0)
+    mini_portile (0.6.2)
+    minitest (5.8.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    paperclip (4.3.1)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      cocaine (~> 0.5.5)
+      mime-types
+      mimemagic (= 0.3.0)
+    polyamorous (1.2.0)
+      activerecord (>= 3.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.4)
+      actionmailer (= 4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      activemodel (= 4.2.4)
+      activerecord (= 4.2.4)
+      activesupport (= 4.2.4)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.4)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.4)
+      actionpack (= 4.2.4)
+      activesupport (= 4.2.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    ransack (1.7.0)
+      actionpack (>= 3.0)
+      activerecord (>= 3.0)
+      activesupport (>= 3.0)
+      i18n
+      polyamorous (~> 1.2)
+    redcarpet (3.3.3)
+    request_store (1.2.0)
+    responders (2.1.0)
+      railties (>= 4.2.0, < 5)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-rails (3.3.3)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sass (3.4.18)
+    sass-rails (5.0.4)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    shoulda-matchers (3.0.0)
+      activesupport (>= 4.0.0)
+    slim (3.0.6)
+      temple (~> 0.7.3)
+      tilt (>= 1.3.3, < 2.1)
+    slim-rails (3.0.1)
+      actionmailer (>= 3.1, < 5.0)
+      actionpack (>= 3.1, < 5.0)
+      activesupport (>= 3.1, < 5.0)
+      railties (>= 3.1, < 5.0)
+      slim (~> 3.0)
+    sprockets (3.4.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.11)
+    temple (0.7.6)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  atomic_cms!
+  factory_girl_rails
+  rspec-core (~> 3.3)
+  rspec-expectations (~> 3.3)
+  rspec-mocks (~> 3.3)
+  rspec-rails
+  rspec-support (~> 3.3)
+  shoulda-matchers
+  sqlite3
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,175 @@
+# Atomic CMS
+The biggest problem with any content management system is the admin users are
+given too much or too little power when editing their site. This gem provides a
+means to manage usage of components created from the gem Atomic Assets. By
+providing admin users with a way to manage their Atomic Assets, developers and
+designers are able to ensure the components they create remained styled properly
+while allowing admins to update their content as needed without developer
+intervention. Below are instructions for getting started.
+
+## Gemfile
+After initializing a new Rails application, or adding to an existing
+application, add the following gems to your Gemfile.
+```ruby
+gem 'atomic_cms', github: 'spartansystems/atomic_cms'
+gem 'devise'
+```
+_Note: devise is optional if you do not want admin users to login._
+
+Then perform a `bundle install`.
+
+## Initialization
+### Active Admin
+To initialize Active Admin:
+```ruby
+rails generate atomic_cms:install
+```
+Remove the comments migration Active Admin created along with disabling comments
+on line 122 of the Active Admin initializer.
+
+Now you shall run the migration and seeds with:
+```ruby
+bundle exec rake db:create
+bundle exec rake db:migrate
+```
+To verify, start the server and visit `localhost:3000/admin`. If you can login
+as `admin@example.com` with the password `password` you have successfully
+completed this step.
+
+### Atomic CMS
+#### Routes
+Update your `config/routes.rb` to include the following:
+```ruby
+mount AtomicCms::Engine => "/atomic_cms", as: :atomic_cms
+# If you are going to use a catch all route add the following line
+get "*path", to: "pages#show", controller: "pages", as: :page, format: false
+root to: 'pages#show', controller: "pages"
+```
+The last two lines need to be at the **END** of your `routes.rb` file.
+
+##### Devise Authentication
+Change the mount point above to be the following:
+```ruby
+  authenticate :admin_user, -> (u) { u.admin? } do
+    mount AtomicCms::Engine => "/atomic_cms", as: :atomic_cms
+  end
+```
+where `u` is the user and `admin?` the authentication method you have on that
+user; it should return a boolean value.
+
+#### Scaffold Generator
+Execute the following to create a model for your static pages:
+```ruby
+rails g atomic_cms:scaffold page
+```
+*After this you should run your migrations.*
+
+Here is a list of everything that is generated for you:
+
+* Model
+* Controller
+* Active Admin Form
+* Migration **Will need to be edited**
+* Show View
+* Route
+
+### Media Upload
+To install the media tables so that you can upload files until your heart is
+literally full run:
+```
+rake atomic_cms:install:migrations
+rake db:migrate
+```
+Also, you should configure paperclip to use s3, since s3 is better than local
+file storage.
+```ruby
+class Application < Rails::Application
+  ...
+  config.paperclip_defaults = {
+    storage: :s3,
+    s3_protocol: "https",
+    s3_credentials: {
+      bucket: ENV.fetch("AWS_S3_BUCKET", ""),
+      access_key_id: ENV.fetch("AWS_ACCESS_KEY", ""),
+      secret_access_key: ENV.fetch("AWS_SECRET", ""),
+      s3_host_name: "s3-#{ENV.fetch('AWS_REGION', '')}.amazonaws.com"
+    }
+  }
+  ...
+end
+```
+
+#### Styles
+In order for component previews to have the proper project styling,
+`active_admin.scss` will need to be updated to import your `application.scss`.
+*NOTE:* If you are using bourbon, bitters, and neat you will not be able to
+straight import `application.scss` as certain styles within base must be
+imported under the `#component_preview` selector. Below is an example of how
+this is properly imported:
+
+```scss
+@import "active_admin/mixins";
+@import "active_admin/base";
+@import "bourbon";
+@import "neat";
+@import "base/variables";
+@import "base/grid-settings";
+@import "atomic_cms";
+
+#component_preview {
+  @import "reset";
+  @import "base/buttons";
+  @import "base/forms";
+  @import "base/lists";
+  @import "base/tables";
+  @import "base/typography";
+  @import "components/*";
+  @include font-feature-settings("kern", "liga", "pnum");
+  -webkit-font-smoothing: antialiased;
+  color: $base-font-color;
+  font-family: $base-font-family;
+  font-size: 16px;
+  line-height: $base-line-height;
+  // When editing a page through the CMS,
+  // images with broken links will not be displayed
+  img[src="image"] {
+    display: none !important;
+  }
+}
+
+// Overriding any non-variable SASS must be done after the fact.
+// For example, to change the default status-tag color:
+//
+//   .status_tag { background: #6090DB; }
+```
+*NOTE:* At the minimum, here is what is needed in `active_admin.scss`:
+```scss
+@import "active_admin/mixins";
+@import "active_admin/base";
+@import "atomic_cms";
+
+#component_preview {
+  // Include application specific styling here
+}
+```
+
+#### Components
+Generate components by executing the following:
+```
+rails g atomic_assets:component text_block
+```
+In order for components to be utilized when managing content, a partial needs to
+be created similar to the following at `app/views/admin/_edit_buttons.html.slim`:
+```slim
+ol.edit-buttons
+  li
+    = link_to 'Text Block', atomic_cms.edit_component_path('text_block'), class: 'button'
+```
+#### Config
+Update `config/application.rb` to include:
+```ruby
+config.autoload_paths += %W(#{config.root}/lib, #{config.root}/app/components/**/)
+```
+### Gotcha's
+When creating a path for a page, from the examples above, make sure to include a
+leading '/', for example: '/home' -or- '/bears'

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+Bundler::GemHelper.install_tasks
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec