simplec 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f687b8e569576f0ede5b259472437ff8108761a
-  data.tar.gz: 1d9a9fa05e066db3fbcb1e43dd4d40b4f27cf13e
+  metadata.gz: f95b9fb5eef66eaf27ab18d642ee76f5ea67a547
+  data.tar.gz: 05505f307bf86ffd6afd16545f5b6a5396a708da
 SHA512:
-  metadata.gz: 86fee8f0499aa2d98e8bc69e1d964b592538b15cfa36413dd65a0a2509c16edc396f0d0ce0e887949c708c4c64b6eff3c8c6a5472a3a5b86c5630796f829146c
-  data.tar.gz: b99fd88d68b73d27feab77a5c600317586fef2ce91a0158820b04113ee36df715f1d756220693d18edfea897d48980441e94a0aba39efff7717d1163b7cb8516
+  metadata.gz: c4cadd40978e45f0f20c8759226bef7ba6d6c2564de022ba589bfd36cf6af9a0520c40979b90c8aa9c764eb68113eaa7353e6da576a4f01bb70d7f291895325e
+  data.tar.gz: 88d5a6034a54698c229887b0ab8165b5c6a0ef9fe309440a63895089cd53726cad136f8015173d597217154fab58d243a9f2b88dea95d35d62e9919dbe113156

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Matt Smith
+
+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,308 @@
+# Simplec
+
+### A CMS for developers, built by developers.
+
+This gem handles all of the rote parts of a CMS, but gets out of the way for
+everything else. In Rails it is easy to build things from scratch, but it is
+a waste of resources to build again and again. This library is an attempt to
+get all of the good parts of a CMS without the baggage of a CMS that takes
+over the entire ecosystem.
+
+## Dependencies
+- rails >= 5.0.5
+
+- pg >= 0.21.0; postgres >= 9.5
+
+    We hate dependencies, but postgres is just too good. We use it for search
+    and JSONB.
+
+- imagemagick
+
+    For image processing.
+
+- dragonfly
+
+    We still hate dependencies, but this is a necessity and the best option.
+
+## Recommended Dependencies
+
+- summernote
+
+    Used for editor fields. Source is included.
+
+- bootstrap-sass >= 3.0.0
+
+    Required if you want to use editor fields (which utilize summernote).
+
+- jquery-rails
+
+    Hope to be able to remove this, but required for summernote/bootstrap for now.
+
+**The recommended dependencies are only required for the admin portions of your
+application.**
+
+_Optionally, you can create a separate set of assets for only the admin via
+standard Rails methods. Or you could not include them and deal with the
+fallout. ;-)_
+
+
+## Features
+- Pages with Templates
+
+- Subdomain support
+
+- Use application models or assets in CMS pages
+
+- Search (coming soon)
+
+## Anti-Features
+- User management
+
+- Permissions
+
+## Proposed auxilary gems
+
+- simplec-vlad: The easiest way to deploy and manage an installation.
+  Database and file syncs between enviroments.
+
+- simplec-blog: Don't always need or want a blog bundled in. (You might have
+  your own.)
+
+- simplec-admin: Opinionated, prebuilt way of managing pages. Take it or leave
+  it. Or don't mount it and generate scaffold controllers and views for basic
+  functions.
+
+- simplec-events
+
+## Usage
+
+1. Add to gemfile
+2. Mount engine
+3. Create pages and corresponding templates
+4. Build, generator, or use an auxilary gem for page admin.
+5. Let users loose.
+
+'www' is considered the default subdomain.
+
+'admin' subdomain is reserved for administration functions if you wish.
+
+If you want to modify all pages you should edit ::Page < Simplec::Page, this
+will be generated in an installer later.
+
+If you want to test a subclass of ::Page, make sure test has ::Page defined.
+
+Create a public layout. The public layout is the default. This will be
+generated in an installer later.
+
+Put page model definitions in `app/models/page/`.
+
+Put model templates in `app/views/pages/`. AND prefix with an underscore (_),
+i.e. `_home.html.erb`.
+
+TODO override field types howto
+
+TODO explain using uuids for keys + pgcrypto
+
+### Steps
+
+1. Install simplec in your Rails application.
+
+    See installation section.
+
+2. Build and admin interface with the rest of your application.
+
+    Simplec doesn't tell you how to do this. Currently, you should look at the
+    test/dummy application for inspiration.
+
+3. Then define a model:
+
+    ```ruby
+    # app/models/page/home.rb
+    class Page::Home < ::Page
+      field :tagline
+    end
+    ```
+
+4. And the corresponding template:
+
+    ```erb
+    <!-- app/views/pages/_home.html.erb -->
+    <h1>My Application</h1>
+    <h2><%= @page.tagline %></h2>
+    ```
+
+    Note: You need to call `#html_safe` on fields with `type: :editor`.
+
+5. And create a page in your admin.
+
+6. Done.
+
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+    ```ruby
+    gem 'pg'
+    gem 'simplec'
+    # plus optional gems
+    ```
+
+    At this point it is assumed you are integrating Simplec into an existing
+    application, logically then you have your database already configured.
+    However, Simplec requires some postgres configuration. Please read the
+    section below on Postgres.
+
+2. Install and run the migrations
+
+    ```shell
+    rake simplec:install:migrations
+    rake db:migrate
+    ```
+
+3. Mount the engine
+
+    ```ruby
+    Rails.application.routes.draw do
+      mount Simplec::Engine => "/"
+    end
+    ```
+
+4. Install and configure `dragonfly`
+
+    ```shell
+    rails generate dragonfly
+    ```
+
+    Then configure `config/initializers/dragonfly.rb`.
+
+    It is recommended to use `rack/cache` or some other HTTP caching solution.
+
+5. Optional - Install bootstap-sass.
+
+    ```ruby
+    gem 'bootstrap-sass', "~> 3.3.7'
+    ```
+
+    Currenty, we have worked out integration with Bootstrap > 3 and are waiting
+    for the dust to settle on V4. See directions here:
+    https://github.com/twbs/bootstrap-sass
+
+6. Optional - If you want to use the bundled summernote:
+
+    Load the JS in your application's manifest.
+
+    ```javascript
+    //= require simplec/summernote
+    //= require simplec/summernote-config
+    ```
+
+    Please note that this needs to be loaded after jquery and bootstrap.
+
+    ```css
+    @import "simplec/summernote";
+    ```
+
+    Please note that this needs to be loaded after bootstrap. And to use
+    `@import` statements, you must use `.scss` files.
+
+## Postgres
+
+Note you will need to do this in your production environment as well. 
+
+On some operating systems, `pgcrypto` is in a separate `postgres` package,
+be sure to install that as well.
+
+The `pgcrypto` extension is required for the `gen_random_uuid()` function
+used to generate uuid primary keys.
+
+1. Create your application postgres user (matching database.yml)
+
+    ```shell
+    # -s for superuser in development
+    createuser -s myapp
+    ```
+
+2. Create databases and add pgcrypto
+
+    ```shell
+    # create development/test databases
+    rake db:create
+
+    # required for gen_random_uuid() function
+    # used for ids in Simplec models
+    #
+    psql myapp_development -c "CREATE EXTENSION pgcrypto;"
+    psql myapp_test -c "CREATE EXTENSION pgcrypto;"
+    ```
+
+## imagemagick
+
+Installation varies per operating system. Image magic is used by dragonfly
+for on the fly (then cached) image manipulation.
+
+See this page for a good cheat sheet: http://markevans.github.io/dragonfly/imagemagick
+
+## Roadmap
+
+1. Finish example admin.
+
+1. Installer `rails generater simplec:install`
+
+1. Upgrade summernote from 0.8.2 to 0.8.6
+
+1. Search
+
+1. Caching
+
+1. Optional Gems
+
+1. Remove as many dependencies as possible.
+
+## Contributing
+1. Use it and file create issues. Somethings are core, other things will be
+  relegated to 3rd party extensions.
+2. Pull requests are welcome. See rule #1.
+
+## TODO
+
+- Document `lib/simplec/controller_extensions.rb`
+
+- Document why _subdomain in subdomain form in admin.
+
+- rails generate simplec:install
+  Install app/models/page.rb, app/models/page/
+  initializer if needed, with options documented
+
+- simplec_path/simplec_url caching
+
+## Running dummy application
+
+1. Create simplec postgres user
+
+        # -s for superuser in development
+        createuser -s simplec
+
+2. Create databases and add pgcrypto
+
+        rake db:create
+
+        # required for gen_random_uuid() function
+        # used for ids in Simplec models
+        #
+        psql simplec_development -c "CREATE EXTENSION pgcrypto;"
+
+3. Migrate database
+
+        rake db:migrate
+
+
+## Contributors
+
+- Matt Smith, Near Apogee Consulting (www.nearapogee.com)
+
+- @lithxe, @jessedo81 for ongoing feedback, use cases, development support,
+  and the initial project to test the concept.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+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    = 'Simplec'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  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'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/simplec_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/simplec .js
+//= link_directory ../stylesheets/simplec .css

data/app/assets/javascripts/simplec/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/simplec/summernote-config.js

@@ -0,0 +1,82 @@
+// Summernote
+//
+//
+$.summernote.options.callbacks.onImageUpload = function(files) {
+  // Dumb but a default or instance callback required to get the
+  // event handler to fire.
+  console.log('image upload:', files);
+};
+$.summernote.options.toolbar = [
+  ['style', ['style']],
+  ['font', ['bold', 'italic', 'underline', 'clear']],
+  // ['font', ['bold', 'italic', 'underline', 'strikethrough', 'superscript', 'subscript', 'clear']],
+  // ['fontname', ['fontname']],
+  // ['fontsize', ['fontsize']],
+  //['color', ['color']],
+  ['para', ['ul', 'ol', 'paragraph']],
+  //['height', ['height']],
+  //['table', ['table']],
+  //['insert', ['link', 'picture', 'hr']],
+  ['insert', ['link', 'picture', 'hr']],
+  ['view', ['fullscreen', 'codeview']],
+  ['help', ['help']]
+];
+
+if (!window.simplec) window.simplec = {};
+
+window.simplec.initSummernote = function() {
+  window.simplec.summernoteInitialized = true;
+
+  $('.editor-field').on('summernote.init', function(event) {
+
+    // Material Kit Hack
+    //$('.note-toolbar .btn-default').
+    //  removeClass('btn-default').addClass('btn-simple');
+
+    //$('.note-popover').css({'display': 'none'}); // BS4 HACK
+    var $editor = $(event.target),
+        $input = $($editor.data('input'));
+    if ($input.val().length > 0) $editor.summernote('code', $input.val());
+  }).on('summernote.change', function(event, contents, $editable) {
+    var $editor = $(event.target),
+        $input = $($editor.data('input'));
+    $input.val(contents);
+  }.bind(window)).on('summernote.image.upload', function(event, files) {
+    console.log('upload event');
+    for (var i = 0; i < files.length; i++) {
+      var file = files[i],
+          reader = new FileReader();
+      reader.onloadend = function() {
+        $.ajax({
+          method: 'POST',
+          url: '/embedded-images',
+          dataType: 'json',
+          contentType: 'application/json',
+          data: JSON.stringify({
+            asset_url: reader.result,
+            asset_name: file.name
+          })
+        }).fail(function(data, textStatus, jqXHR){
+          console.log('IMAGE UPLOAD FAIL', textStatus);
+        }).done(function(data, textStatus, jqXHR){
+          $(event.target).summernote(
+            'insertImage',
+            jqXHR.responseJSON.asset_url, jqXHR.responseJSON.asset_name
+          );
+        });
+      };
+      reader.readAsDataURL(file);
+    }
+  });
+
+  $('.editor-field').summernote({
+    height: 500,
+    minHeight: 100,
+    maxHeight: 1200
+  });
+
+};
+
+$(document).on('ready turbolinks:load', function() {
+  if (!window.simplec.summernoteInitialized) window.simplec.initSummernote();
+});