active_copy 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f227f3674215e99c1215397cbb5bef2284592aa
+  data.tar.gz: 7547b592fb262663e9bafddcbfc8a2786f67352f
+SHA512:
+  metadata.gz: 12dd750c3aad0897785a75d86bae5ff9346bcd7ba1aeaa7e43d5eb4801d9f21861d90617d6713fe2bbe8c4b394100960674c46cd91c5bb26dad1b834c1019dd3
+  data.tar.gz: 07b3e2d159e133d21df8985c457b08d889ee744c1e741d41ad8424a2362214e06d41f48e4db18efb1590ab9c046feee30f9cede1421939bec109c4a076981e82

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+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 @@
+--color --format=documentation

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in active_copy.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    active_copy (1.0.0.pre)
+      pygments.rb (~> 0.3)
+      rails
+      redcarpet
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.1)
+      actionpack (= 4.0.1)
+      mail (~> 2.5.4)
+    actionpack (4.0.1)
+      activesupport (= 4.0.1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.1)
+      activesupport (= 4.0.1)
+      builder (~> 3.1.0)
+    activerecord (4.0.1)
+      activemodel (= 4.0.1)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.1)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    polyglot (0.3.3)
+    posix-spawn (0.3.6)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pygments.rb (0.5.4)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.1)
+      actionmailer (= 4.0.1)
+      actionpack (= 4.0.1)
+      activerecord (= 4.0.1)
+      activesupport (= 4.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.1)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.1)
+      actionpack (= 4.0.1)
+      activesupport (= 4.0.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    redcarpet (3.0.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.4.7)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+    yajl-ruby (1.1.0)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_copy!
+  pry
+  rspec
+  sqlite3
+  yard

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,77 @@
+# ActiveCopy
+
+ActiveCopy is a Rails model layer for reading from static page files.
+Inspired by [Jekyll][jekyll], it hacks ActionView to allow for storage
+of static page content inside app/views as YAML Front Matter/Markdown.
+
+Although it's still very much a work in progress, ActiveCopy is being
+used in production on <http://psychedeli.ca>.
+
+## Setup
+
+Add to Gemfile:
+
+```ruby
+gem 'active_copy'
+```
+
+And generate a model:
+
+```bash
+$ rails generate copy article
+```
+
+You'll get this as **app/models/article.rb**:
+
+```ruby
+class Article < ActiveCopy::Base
+  attr_accessible :title
+end
+```
+
+You'll also see a generator pop up in **lib/generators** that
+corresponds to the name you gave the original generator. The `copy`
+generator actually "generates a generator" so that you can more easily
+generate your custom model records (files).
+
+## Usage
+
+You can define articles in **app/views/articles/content/your-article.md**:
+
+```markdown
+---
+title: "The title of your article"
+---
+
+Hi I'm a static article.
+```
+
+Retrieve that article from a param in your route:
+
+```ruby
+class ArticlesController < ApplicationController
+  def show
+    @article = Article.find params[:id]
+
+    respond_with @article
+  end
+end
+```
+
+And show the article in your view:
+
+```haml
+#article
+  %h1= @article.name
+  .content= @article.content
+```
+
+## Contributing
+
+You can contribute by making a GitHub pull request. Please include tests
+with your feature/bug fix and an ample description as to why you're
+fixing the bug.
+
+### Roadmap
+
+- Generators

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new :test
+
+task :default => %w(test build)

data/active_copy.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "active_copy/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "active_copy"
+  s.version     = ActiveCopy::VERSION
+  s.authors     = ["Tom Scott"]
+  s.email       = ["tubbo@psychedeli.ca"]
+  s.homepage    = "http://github.com/tubbo/active_copy"
+  s.summary     = "Use the Rails model layer as a backend for static files"
+  s.description = s.summary
+
+  s.files = `git ls-files`.split "\n"
+  s.test_files = s.files.grep(/\Aspec/)
+
+  s.add_dependency "rails"
+  s.add_dependency 'pygments.rb', '~> 0.3'
+  s.add_dependency 'redcarpet'
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "pry"
+end

data/config/initializers/register_active_copy_template_handler.rb

@@ -0,0 +1,4 @@
+require 'active_copy'
+
+# Add the Markdown template handler.
+ActionView::Template.register_template_handler :md, ActiveCopy::Template

data/lib/active_copy.rb

@@ -0,0 +1,21 @@
+require 'active_copy/attributes'
+require 'active_copy/base'
+require 'active_copy/markdown'
+require 'active_copy/template'
+require 'active_copy/view_helper'
+require 'active_copy/version'
+
+# ActiveCopy reads Markdown files in +app/documents+ instead of a
+# database for your Rails models. Inspired by Jekyll, it uses compatible
+# YAML front matter to set up the metadata for each page, then renders its
+# content using +ActionView+. In production, +Rake+ tasks are provided to
+# precompile the Markdown files to pure HTML for performance purposes.
+module ActiveCopy
+  def self.content_path
+    @content_path = if ENV['RAILS_ENV'] == 'test'
+      'spec/fixtures'
+    else
+      'app/views'
+    end
+  end
+end

data/lib/active_copy/attributes.rb

@@ -0,0 +1,58 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/string/inflections'
+
+module ActiveCopy
+  # Attribute storage and handling for +ActiveCopy+ models.
+  module Attributes
+    extend ActiveSupport::Concern
+
+    DEFAULT_PATH = "public/#{self.class.name.parameterize.pluralize}"
+    DEFAULT_ATTRS = [:layout]
+
+    included do
+      class_attribute :_accessible_attributes
+      class_attribute :_deployment_path
+    end
+
+    module ClassMethods
+      def attr_accessible(*args)
+        if self._accessible_attributes.nil?
+          self._accessible_attributes = []
+        end
+
+        args.each do |attribute|
+          self._accessible_attributes << attribute
+        end
+      end
+
+      def deploy_to file_path
+        self._deployment_path = file_path
+      end
+
+      def accessible_attrs
+        return DEFAULT_ATTRS if self._accessible_attributes.nil?
+        self._accessible_attributes += DEFAULT_ATTRS
+      end
+
+      def deployment_path
+        self._deployment_path || "#{DEFAULT_PATH}/#{self.id}.html"
+      end
+    end
+
+    # Take YAML front matter given by id.
+    def attributes
+      @attributes ||= yaml_front_matter.with_indifferent_access
+    end
+
+    protected
+    def attribute? key
+      self.class.accessible_attrs.include? key.to_sym
+    end
+
+    private
+    def yaml_front_matter
+      HashWithIndifferentAccess.new \
+        YAML::load(raw_source.split("---\n")[1])
+    end
+  end
+end

data/lib/active_copy/base.rb

@@ -0,0 +1,34 @@
+require 'active_model'
+require 'active_copy/attributes'
+require 'active_copy/finders'
+require 'active_copy/paths'
+require 'active_copy/source'
+
+# Base class for an +ActiveCopy+ model.
+
+module ActiveCopy
+  class Base
+    include ActiveModel::Model
+    include Attributes, Finders, Paths, Source
+
+    attr_accessor :id
+
+    # Serialize comma-separated tags to an array.
+    def tags
+      attributes[:tags].split(',').map(&:strip)
+    end
+
+    class << self
+      # New and create are the same thing.
+      alias create new
+    end
+
+    # Files are persisted when they are present on disk.
+    alias persisted? present?
+
+    def method_missing method, *arguments
+      super method, *arguments unless attribute? "#{method}"
+      attributes[method]
+    end
+  end
+end

data/lib/active_copy/finders.rb

@@ -0,0 +1,61 @@
+
+# Methods for finding records on the filesystem.
+
+module ActiveCopy
+  module Finders
+    extend ActiveSupport::Concern
+
+    # Test if the query matches this particular model.
+    def matches? query
+      query.reduce(true) do |matches, (key, value)|
+        matches = if key == 'tag'
+          return false unless tags.present?
+          tags.include? value
+        else
+          attributes[key] == value
+        end
+      end
+    end
+
+    module ClassMethods
+      # Return the folder where all documents are stored for this model.
+      def collection_path
+        @collection_path ||= "#{ActiveCopy.content_path}/#{name.tableize}/content"
+      end
+
+      # Find this model by its filename.
+      def find by_filename
+        if File.exists? "#{Rails.root}/#{collection_path}/#{by_filename}.md"
+          new id: by_filename
+        else
+          nil
+        end
+      end
+
+      # Read all files from the +collection_path+, then instantiate them
+      # as members of this model. Return as an +Array+.
+      def all
+        Dir["#{absolute_collection_path}/*.md"].reduce([]) do |articles, md_path|
+          unless md_path == "#{Rails.root}/#{collection_path}"
+            file_name = File.basename(md_path).gsub('.md', '')
+            articles << self.new(id: file_name)
+          end
+        end
+      end
+
+      # Look for all of the matching key/value pairs in the YAML front
+      # matter, and return an array of models that match them.
+      def where query={}
+        all.reject { |a| a.nil? }.reduce([]) do |results, article|
+          results << article if article.matches? query
+          results
+        end
+      end
+
+      private
+      def absolute_collection_path
+        "#{Rails.root}/#{collection_path}"
+      end
+    end
+  end
+end