vapid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b99f1a8446492ac2d5abf7a36c03ab771bfeff8f
+  data.tar.gz: 58e5c6732a676566be85c7a2d63d04c672d21889
+SHA512:
+  metadata.gz: 4a7cae0ccf832297e4c31d15b244817e4aa9248d1bd837b7cbdeea70ffabe7accf90ec2a0d323ef6e9a9ed657e59070de8896aa375769048c06a8d7921e7db2c
+  data.tar.gz: 1fb354a0209079ec0663f468e56654157da5e3351d1d218f7d46142905145231be4b0bbf1f29b5ceb11a5751ce73d06518412c255f01449e1b09c890c8ec8033

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "lib/vapid/vendor/semantic-ui"]
+	path = lib/vapid/vendor/semantic-ui
+	url = https://github.com/Semantic-Org/Semantic-UI-CSS
+[submodule "lib/vapid/vendor/trix"]
+	path = lib/vapid/vendor/trix
+	url = https://github.com/basecamp/trix

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,133 @@
+AllCops:
+  Exclude:
+    - "**/vendor/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "vapid.gemspec"
+    - "spec/**/*.rb"
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Style/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Style/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Style/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Style/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Style/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Style/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Style/IndentationWidth:
+  Enabled: true
+
+Style/SpaceAfterColon:
+  Enabled: true
+
+Style/SpaceAfterComma:
+  Enabled: true
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Style/SpaceAroundKeyword:
+  Enabled: true
+
+Style/SpaceAroundOperators:
+  Enabled: true
+
+Style/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Style/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Style/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Style/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Style/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+  

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+gemspec
+
+group :test do
+  gem "database_cleaner"
+  gem "factory_girl"
+  gem "faker"
+  gem "simplecov", require: false
+  gem "sqlite3"
+end

data/README.md

@@ -0,0 +1,37 @@
+# Vapid
+
+The world's dumbest content management system.
+
+TODO: Fill in the README file
+
+## Installation
+
+```ruby
+gem install vapid
+```
+
+## Usage
+
+To create a new project:
+
+    $ vapid new /path/to/project
+    $ cd /path/to/project
+
+Then run the local development server:
+
+    $ vapid server
+
+Add HTML attributes to describe the editable content:
+
+```html
+<h1 vp-text="headline"></h1>
+```
+
+When you're ready, run the `build` command. Vapid will look at your project templates, and construct the control panel:
+
+    $ vapid build
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vapid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/vapid

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + "/../lib")
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "vapid"
+Vapid::CLI.start(ARGV)

data/lib/vapid.rb

@@ -0,0 +1,24 @@
+require "vapid/version"
+
+# Adding a method to Object
+class Object
+  def blank?
+    respond_to?(:empty?) ? !empty? : !self
+  end
+end
+
+# Top-level namespace
+module Vapid
+  autoload :Builder,    "vapid/builder"
+  autoload :CLI,        "vapid/cli"
+  autoload :Directive,  "vapid/directive"
+  autoload :Directives, "vapid/directives"
+  autoload :Models,     "vapid/models"
+  autoload :Server,     "vapid/server"
+  autoload :Settings,   "vapid/settings"
+  autoload :Template,   "vapid/template"
+
+  def self.register_directive(name, klass)
+    Directives.register name, klass
+  end
+end

data/lib/vapid/assets/javascripts/vapid/admin.coffee

@@ -0,0 +1,2 @@
+#= require trix/dist/trix
+#= require_self

data/lib/vapid/assets/stylesheets/vapid/admin.scss

@@ -0,0 +1,72 @@
+//= require semantic-ui/components/reset
+//= require semantic-ui/components/button
+//= require semantic-ui/components/divider
+//= require semantic-ui/components/form
+//= require semantic-ui/components/grid
+//= require semantic-ui/components/header
+//= require semantic-ui/components/icon
+//= require semantic-ui/components/image
+//= require semantic-ui/components/message
+//= require semantic-ui/components/menu
+//= require semantic-ui/components/segment
+//= require semantic-ui/components/sidebar
+//= require semantic-ui/components/site
+//= require semantic-ui/components/table
+//= require trix/dist/trix
+//= require_self
+
+@font-face {
+  font-family: 'Icons';
+  src: url("../../semantic-ui/themes/default/assets/fonts/icons.eot");
+  src: url("../../semantic-ui/themes/default/assets/fonts/icons.eot?#iefix") format('embedded-opentype'), 
+       url("../../semantic-ui/themes/default/assets/fonts/icons.woff2") format('woff2'), 
+       url("../../semantic-ui/themes/default/assets/fonts/icons.woff") format('woff'), 
+       url("../../semantic-ui/themes/default/assets/fonts/icons.ttf") format('truetype'), 
+       url("../../semantic-ui/themes/default/assets/fonts/icons.svg#icons") format('svg');
+  font-style: normal;
+  font-weight: normal;
+  font-variant: normal;
+  text-decoration: inherit;
+  text-transform: none;
+}
+
+body > .grid {
+  height: 100%;
+}
+
+body.admin {
+  .pusher {
+    padding: 1rem 2rem 1rem 17rem;
+  }
+
+  .ui.form {
+    max-width: 40rem;
+    padding-bottom: 5rem;
+  }
+
+  form.ui.button input[type="submit"] {
+    padding: 0;
+    border: none;
+    outline: none;
+    line-height: 1em;
+    background: none;
+  }
+
+  .preview,
+  .destroy {
+    margin-top: 1em;
+  }
+
+  .destroy {
+    input[type=checkbox] { 
+      vertical-align: middle;
+      margin-right: 0.5em;
+    }
+  }
+}
+
+body.admin_form {
+  .column {
+    max-width: 35em;
+  }
+}

data/lib/vapid/builder.rb

@@ -0,0 +1,70 @@
+module Vapid
+  # Scrapes templates, and builds data models
+  class Builder
+    class << self
+      def build!(template_files, &block)
+        project_tree = build_project_tree(template_files, &block)
+        groups = consolidate_into_groups(project_tree)
+        update_data_model(groups)
+        remove_unused_groups(groups)
+      end
+
+      private
+
+        def build_project_tree(template_files)
+          template_files.reduce({}) do |project_tree, file|
+            yield file if block_given?
+            project_tree.deep_merge parse_file(file)
+          end
+        end
+
+        def consolidate_into_groups(project_tree)
+          project_tree.each_with_object({}) do |(group_key, field_keys), groups|
+            directive = Directives[:group].new(group_key)
+            group_name = directive.subject
+            groups[group_name] ||= { repeating: false, fields: {} }
+            groups[group_name][:repeating] ||= directive.repeating?
+            groups[group_name][:fields].merge! get_content_fields(field_keys)
+          end
+        end
+
+        def update_data_model(groups)
+          groups.each do |name, attributes|
+            group = Models::Group.named(name) || Models::Group.new(name: name)
+            group.update_attributes attributes
+            prune_orphaned_content(group)
+          end
+        end
+
+        def parse_file(file)
+          html = File.open(file).read
+          Template.new(html).tree
+        end
+
+        def get_content_fields(field_keys)
+          field_keys.each_with_object({}) do |(field_key, field_types), fields|
+            content_type = field_types.reverse.find { |t| content_directives.include?(t) }
+            unless content_type.nil?
+              field_directive = Directives[content_type].new(field_key)
+              fields[field_directive.subject] = content_type
+            end
+          end
+        end
+
+        def prune_orphaned_content(group)
+          group.records.each do |record|
+            record.content.delete_if { |k, _v| !group.fields.include?(k) }
+            record.save
+          end
+        end
+
+        def remove_unused_groups(used_groups)
+          Models::Group.where.not(name: used_groups.keys).destroy_all
+        end
+
+        def content_directives
+          @content_directives ||= Directives.content_changers.keys
+        end
+    end
+  end
+end

data/lib/vapid/cli.rb

@@ -0,0 +1,96 @@
+require "thor"
+require "guard"
+require "guard/commander"
+require "thread"
+
+module Vapid
+  # Command line interface
+  class CLI < Thor
+    include Thor::Actions
+    default_task :help
+
+    GUARDFILE = %(
+      guard 'livereload' do
+        watch('.cache/livereload.txt')
+        watch(%r{templates/.+})
+        watch(%r{assets/.+})
+      end
+    ).freeze
+
+    def self.source_root
+      "#{File.dirname(__FILE__)}/generator_template"
+    end
+
+    desc "new TARGET", "Create a new project in the TARGET directory"
+    map %w(n -n --new) => :new
+    def new(target)
+      say "== Creating a new Vapid project in #{expanded_target(target)}"
+      directory ".", target
+      inside_target(target) do
+        run "bundle install"
+      end
+    end
+
+    desc "server", "Start the server"
+    map %w(s -s --server) => :server
+    method_option :port, aliases: %w(-p), type: :numeric
+    method_option :bind, aliases: %w(-b), type: :string
+    def server(target = ".")
+      say "== The Vapid server is loading"
+      inside_target(target) do
+        Thread.abort_on_exception = true
+        Thread.new do
+          Server.run! options
+        end
+
+        Guard.start guardfile_contents: GUARDFILE, watchdir: target, no_interactions: true
+      end
+      say "== The Vapid server is now shut down"
+    end
+
+    desc "build", "Updates the data model as described in your templates"
+    map %w(b -b --build) => :build
+    def build(target = ".")
+      inside_target(target) do
+        Models.migrate!
+        ensure_user_exists
+
+        say "== Parsing templates for fields"
+        template_files = Dir[File.join(target, "templates", "**/*")].reject { |f| File.directory? f }
+        Builder.build!(template_files) do |filepath|
+          say "  * #{filepath}"
+        end
+        say "== Build complete"
+      end
+    end
+
+    desc "version", "Show the Vapid version number"
+    map %w(v -v --version) => :version
+    def version
+      say "Vapid #{Vapid::VERSION}"
+    end
+
+    private
+
+      def inside_target(target, &block)
+        if !File.exist? File.join(target, "config.ru")
+          say "== Could not find a Vapid project in #{expanded_target(target)}"
+        else
+          FileUtils.mkdir_p File.join(target, ".cache")
+          inside(target, &block)
+        end
+      end
+
+      def expanded_target(target)
+        File.expand_path(target)
+      end
+
+      def ensure_user_exists
+        return if Models::User.any?
+        say "== Creating an admin login"
+        email = ask "What is your email address?", default: "admin@example.com"
+        password = ask "Enter a password:", default: "password", echo: false
+        Models::User.create email: email, password: password
+      end
+  end
+end