character 0.1.0 → 1.0.0

data/lib/character/generators/bootstrap_generator.rb

@@ -0,0 +1,51 @@
+require 'rails/generators'
+
+module Character
+  module Generators
+    class BootstrapGenerator < ::Rails::Generators::Base
+      desc "Setup posts, pages and admin."
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def override_layout
+        copy_file 'application.html.erb', 'app/views/layouts/application.html.erb'
+      end
+
+      def copy_initializer_file
+        copy_file "initializer.rb", "config/initializers/character.rb"
+      end
+
+      def copy_settings_file
+        copy_file "settings.yml", "config/settings.yml"
+      end
+
+      def setup_assets
+        copy_file "admin.coffee", "app/assets/javascripts/admin.coffee"
+        copy_file "admin.scss", "app/assets/stylesheets/admin.scss"
+        copy_file "assets.rb", "config/initializers/assets.rb"
+        copy_file "application.scss", "app/assets/stylesheets/application.scss"
+
+        # TODO: remove application.css file
+        # TODO: create application folder
+
+        copy_file "typography.scss", "app/assets/stylesheets/application/typography.scss"
+        copy_file "settings.scss", "app/assets/stylesheets/application/settings.scss"
+      end
+
+      def add_routes
+        inject_into_file "config/routes.rb", before: "  # The priority is based upon order of creation: first created -> highest priority.\n" do <<-'RUBY'
+mount_character_instance 'admin'
+mount_posts_at '/'
+mount_pages_at '/'
+RUBY
+        end
+      end
+
+      def remove_assets_require_tree
+        gsub_file 'app/assets/javascripts/application.js', "//= require_tree .\n", ''
+
+        # TODO: this file should be removed
+        # gsub_file 'app/assets/stylesheets/application.css', " *= require_tree .\n", ''
+      end
+    end
+  end
+end

data/lib/character/instance.rb

@@ -0,0 +1,59 @@
+module Character
+  class Instance
+    DEFAULT_NAME = 'admin'
+
+    attr_accessor :name,
+                  :title,
+                  :user_model,
+
+                  :before_index,
+                  :before_save,
+
+                  :javascript_filename,
+                  :stylesheet_filename,
+
+                  :development_auto_login,
+                  :force_ssl,
+
+                  # defined in config/settings.yml
+                  :settings,
+                  :logo,
+                  :login_background
+
+    def initialize(name = Instance::DEFAULT_NAME)
+      @name                   = name.gsub(' ', '-').downcase
+      @title                  = 'Character'
+      @user_model             = 'Character::User'
+      @development_auto_login = false
+      @force_ssl              = true
+    end
+
+    def title
+      @title || @name.humanize
+    end
+
+    def javascript_filename
+      @javascript_filename || @name
+    end
+
+    def stylesheet_filename
+      @stylesheet_filename || @name
+    end
+
+    def user_class
+      @user_class ||= @user_model.constantize
+    end
+
+    def settings
+      @settings ||= ::Settings.group(@name.capitalize)
+    end
+
+    def logo
+      @logo ||= settings['Logo'].value
+    end
+
+    def login_background
+      @login_background ||= settings['Login Background'].value
+    end
+  end
+end

data/lib/character/routing.rb

@@ -1,10 +1,47 @@
 module ActionDispatch::Routing
   class Mapper
-    def mount_character
-      scope '/admin', :module => "Character" do
-        scope 'character' do
-          resources :posts, only: [:index, :create, :update, :destroy]
-        end
+    def mount_character_instance(name='admin')
+      scope "/#{ name }", :module => "character" do
+        get   '/',       to: 'application#index'
+        match '/login',  to: 'application#login',  via: [ :post, :get ]
+        match '/logout', to: 'application#logout', via: [ :post, :get ]
+
+        # settings api
+        get  '/settings/:template_name(.:format)', to: 'settings#show'
+        post '/settings/:template_name(.:format)', to: 'settings#update'
+
+        # generic api
+        get    '/:model_slug(.:format)',           to: 'api#index'
+        get    '/:model_slug/new(.:format)',       to: 'api#new'
+        get    '/:model_slug/:id(.:format)',       to: 'api#show'
+        get    '/:model_slug/:id/edit(.:format)',  to: 'api#edit'
+        match  '/:model_slug(.:format)',           to: 'api#create', via: [ :post, :put, :patch ]
+        post   '/:model_slug/:id(.:format)',       to: 'api#update'
+
+        # workaround for test environment, "patch" not working
+        # Maxim
+        patch  '/:model_slug/:id(.:format)',       to: 'api#patch'
+        # Alex: I guess we need patch here
+        #put  '/:model_slug/:id(.:format)',       to: 'api#patch'
+
+
+        delete '/:model_slug/:id(.:format)',       to: 'api#destroy'
+      end
+    end
+
+    def mount_posts_at(mount_location)
+      scope mount_location do
+        get '/'              => 'posts#index',    as: :posts_index
+        get '/a/:slug'       => 'posts#author',   as: :posts_author
+        get '/c/:slug'       => 'posts#category', as: :posts_category
+        get '/p/:slug'       => 'posts#show',     as: :posts_show
+        get '/rss(.:format)' => 'posts#rss',     as: :posts_rss
+      end
+    end
+
+    def mount_pages_at(mount_location)
+      scope mount_location do
+        get '/:path' => 'pages#show', as: :pages_show, :constraints => {:path => /.*/}
       end
     end
   end

data/lib/character/settings.rb

@@ -0,0 +1,101 @@
+module Settings
+  # TODO: this module should be refactored
+  # - now we ping db to get every single value
+  # - need to cache all values in one request, so ping db once per request
+
+  mattr_accessor :settings_file
+  @@settings_file = "config/settings.yml"
+
+  def self.value(key)
+    group_name, value_name = key.split('::')
+    if groups.has_key? group_name and groups[group_name].has_key? value_name
+      groups[group_name][value_name].value
+    else
+      ''
+    end
+  end
+
+  def self.group(group_name)
+    groups[group_name]
+  end
+
+  def self.groups
+    unless @groups
+      @groups = {}
+      settings_from_yml.keys.each do |group_name|
+        @groups[group_name] = settings_from_yml[group_name].map do |name, attrs|
+          [ name, Variable.new(group_name, name, attrs) ]
+        end.to_h
+      end
+    end
+    @groups
+  end
+
+  def self.settings_from_yml
+    unless @settings_from_yml
+      settings_file = ::Rails.root.join(@@settings_file)
+      @settings_from_yml = {}
+
+      if File.exists?(settings_file)
+        data = YAML::load(ERB.new(IO.read(settings_file)).result)
+        @settings_from_yml = data if data
+      end
+    end
+    @settings_from_yml
+  end
+
+  def self.stored_variables
+    @stored_variables ||= Character::Settings::Variable.all
+    Character::Settings::Variable.all
+  end
+
+  class Variable
+    attr_accessor :group,
+                  :name,
+                  :type,
+                  :description,
+                  :default_value
+
+    def initialize(group, name, attrs)
+      @group         = group
+      @name          = name
+      @type          = attrs['type']          || 'string'
+      @description   = attrs['description']   || ''
+      @default_value = attrs['default_value'] || ''
+    end
+
+    def stored_object
+      Character::Settings::Variable.find_or_create_by(name: @name, group: @group)
+    end
+
+    def value
+      object = stored_object
+      value  = object.value || @default_value
+
+      if @type == 'file'
+        if object.has_file_uploaded?
+          # return uploaded file
+          return object.file.to_s
+        elsif value.include? '//'
+          # return direct link to file
+          return value
+        elsif value.empty?
+          # return empty string
+          return value
+        else
+          # return rails asset
+          return ActionController::Base.helpers.asset_path(value)
+        end
+
+      elsif @type == 'integer'
+        return value.to_i
+
+      elsif @type == 'float'
+        return value.to_f
+
+      else # string
+        return value
+      end
+    end
+  end
+end

data/lib/character/templates/admin.coffee

@@ -0,0 +1,15 @@
+#= require character
+
+# Modules =================================================
+
+chr.dashboardModule()
+chr.postsModule()
+chr.pagesModule()
+
+# Settings Modules ========================================
+
+chr.settingsWebsite()
+chr.settingsLayout()
+chr.settingsRedirects()
+chr.settingsPostCategories()
+chr.settingsAdmins()

data/lib/character/templates/admin.scss

@@ -0,0 +1,3 @@
+@import "character";
+
+.post, .page { @import "application/typography"; letter-spacing: 0; }

data/lib/character/templates/application.html.erb

@@ -0,0 +1,44 @@
+<!doctype html>
+<html class="no-js">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+    <%= display_meta_tags title: @title,
+                          description: @description,
+                          canonical: "http://#{ @domain }",
+                          open_graph: { type: 'website',
+                                        title: @title,
+                                        description: @description,
+                                        url: "http://#{ @domain }" } %>
+
+    <link rel="alternate" type="application/rss+xml" title="RSS" href="http://<%= @domain %><%= posts_rss_path %>" />
+
+    <%= stylesheet_link_tag "application" %>
+    <%= javascript_include_tag :modernizr %>
+    <%= csrf_meta_tags %>
+  </head>
+
+  <body>
+    <!--[if lt IE 8]>
+        <p class="browsehappy">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</p>
+    <![endif]-->
+
+    <header class='header'>
+      <div class='container'>
+        <%= @header_html.html_safe %>
+      </div>
+    </header>
+
+    <%= yield %>
+
+    <footer class='footer'>
+      <div class='container'>
+        <%= @footer_html.html_safe %>
+      </div>
+    </footer>
+
+    <%= javascript_include_tag "application" %>
+    <%= render partial: 'shared/google_analytics' %>
+  </body>
+</html>

data/lib/character/templates/application.scss

@@ -0,0 +1,12 @@
+//= require normalize
+
+// http://www.paulirish.com/2012/box-sizing-border-box-ftw/
+// apply a natural box layout model to all elements
+*, *:before, *:after { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; }
+
+@import "application/settings";
+
+html                                  { // Make everything look a little nicer in webkit
+                                        -webkit-font-smoothing: antialiased;
+                                        @import "application/typography";
+}

data/lib/character/templates/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile += %w( admin.css admin.js )

data/lib/character/templates/initializer.rb

@@ -0,0 +1,5 @@
+Character.configure do |config|
+  config.title = 'Website Admin'
+  # config.force_ssl = false
+  # config.development_auto_login = true
+end

data/lib/character/templates/settings.scss

@@ -0,0 +1,11 @@
+
+$baseColor:        rgba(0,0,0,0.8);
+$linkColor:        #222;
+$baseFontFamily:   'Georgia', serif;
+$headerFontFamily: 'Myriad Pro', sans-serif;
+$codeFontFamily:   'Monaco', monospace;
+$baseFontSize:     20;
+$baseLineHeight:   1.5;
+$h1:               0.33 * 7.3;
+$h2:               0.33 * 4.3;
+$h3:               0.33 * 3.3;

data/lib/character/templates/settings.yml

@@ -0,0 +1,67 @@
+# ================================================================================
+#   character_settings.yml ---configuration file v1.0---
+# ================================================================================
+# This file is used to store a list of character settings. Settings are split into
+# groups like this:
+#
+#   Group Name:
+#     Variable Title:
+#       type:            string (default) / text / file / link
+#       description:     setting one sentence description
+#       default_value:   default value is used when setting value is blank
+#
+# PS: Link value format: (link title) http://link.url
+# --------------------------------------------------------------------------------
+
+# Default Settings
+
+Admin:
+  Logo:
+    type: file
+    description: 'Company logo'
+    default_value: 'character/logo.jpg'
+
+  Login Background:
+    type: file
+    description: 'Background for login page'
+    default_value: ''
+
+# END
+
+# Website Settings
+
+Website:
+  Domain:
+    type: string
+    description: 'Website domain is used in links.'
+    default_value: 'www.website.com'
+
+  Title:
+    type: string
+    description: 'Title for the website is used by search engines.'
+    default_value: 'Website'
+
+  Description:
+    type: text
+    description: 'What this website is about? This is used by search engines.'
+    default_value: 'This website is built with character.'
+
+  Google Analytics ID:
+    type: string
+    description: 'Something that looks like like: UA-38088276-3'
+    default_value: ''
+
+# END
+
+# Layout
+
+Layout:
+  Header:
+    type: code
+    description: ''
+    default_value: "<h1>Project Title</h1><p><a href='/' title='Home'>Home</a></p>"
+
+  Footer:
+    type: code
+    description: ''
+    default_value: '<p>© Project™ 2014. All rights reserved.</p>'

data/lib/character/templates/typography.scss

@@ -0,0 +1,13 @@
+@import "rhythm/typography";
+@import "settings";
+
+@include typography( $baseColor,
+                     $linkColor,
+                     $baseFontFamily,
+                     $headerFontFamily,
+                     $codeFontFamily,
+                     $baseFontSize,
+                     $baseLineHeight,
+                     $h1,
+                     $h2,
+                     $h3 );