static_post 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d13f87edd7a06afd15292127669b0ed8c67d516a
+  data.tar.gz: 5b34eb26147e9652076ec47bb34c8191a284431e
+SHA512:
+  metadata.gz: aebb0142fc0bddeed1ebbe123b14c02ee03fe670a851a3b77a50338228f6e28ed9e66045eb6b99f841b7250674de3d26a9d0b0b33fb98ad5b9607daf998b1b16
+  data.tar.gz: 216148bc676c3332e72f7277e026f72b9d65ca910fa55e73ad2a1076fdbfc4a6a53b0bb51786c0aef63b3e6cb59ec620d1ccf3ef768a4b2dd9e8df95b2ed909e

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    static_post (0.1.0)
+      activemodel
+      redcarpet
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    builder (3.2.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.2)
+    method_source (0.8.2)
+    minitest (5.5.1)
+    parser (2.2.0.3)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    redcarpet (3.2.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubocop (0.29.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  pry
+  rake
+  rspec
+  rubocop
+  static_post!

data/README.md

@@ -0,0 +1,2 @@
+# Static Post
+*Please note:* This project is still a work in progress.

data/Rakefile

@@ -0,0 +1,3 @@
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+task default: %w[test]

data/lib/static_post.rb

@@ -0,0 +1,11 @@
+require 'active_model'
+require 'redcarpet'
+require 'yaml'
+require 'static_post/version'
+require 'static_post/base'
+
+module StaticPost
+  SETTINGS = {
+    renderer: Redcarpet::Render::HTML.new
+  }
+end

data/lib/static_post/base.rb

@@ -0,0 +1,75 @@
+module StaticPost
+  class Base
+    extend ActiveModel::Naming
+
+    class << self
+      FRONTMATTER_CONTENT = /^\s*---\n+(.*?)\n+---/
+      FRONTMATTER = /^\s*---\n+.*?\n+---/
+
+      def all
+        @posts || load_posts
+      end
+
+      def post_path(path = nil)
+        if path.nil?
+          @post_path.nil? ? default_post_path : @post_path
+        else
+          @post_path = File.expand_path(path)
+        end
+      end
+
+      def default_post_path
+        if defined?(Rails)
+          File.expand_path('app/views/posts', Rails.root)
+        else
+          File.expand_path('.')
+        end
+      end
+
+      def compile(content)
+        @compiler = Redcarpet::Markdown.new(SETTINGS[:renderer])
+        @compiler.render(content)
+      end
+
+      def load_posts
+        @posts = post_files.map do |file, i|
+          create_record(file, i)
+        end
+      end
+
+      def post_files
+        Dir.entries("#{@post_path}").select do |file|
+          file unless File.directory?(file)
+        end
+      end
+
+      def create_record(file, id)
+        {
+          id: id,
+          attributes: extract_attributes(file)
+        }
+      end
+
+      def extract_attributes(file)
+        file_content = File.read(file)
+        {
+          content: post_content(file_content)
+        }.merge(extract_frontmatter(file_content))
+      end
+
+      def extract_frontmatter(content)
+        frontmatter = content.match(FRONTMATTER_CONTENT).captures
+        if frontmatter.any?
+          attributes = YAML.load(frontmatter.first)
+          Hash[attributes.map { |k, v| [k.to_sym, v] }]
+        else
+          {}
+        end
+      end
+
+      def post_content(content)
+        compile(content.sub(FRONTMATTER, ''))
+      end
+    end
+  end
+end

data/lib/static_post/version.rb

@@ -0,0 +1,3 @@
+module StaticPost
+  VERSION = '0.1.0'
+end

data/lib/tasks/lint.rake

@@ -0,0 +1,7 @@
+require 'rubocop/rake_task'
+
+desc 'Lint source code with RuboCop'
+RuboCop::RakeTask.new(:lint) do |t|
+  t.patterns = ['lib/**/*.rb', 'spec/*.rb']
+  t.fail_on_error = false
+end

data/lib/tasks/test.rake

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+
+desc 'Run tests with Rspec'
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = Dir.glob('spec/*_spec.rb')
+  t.rspec_opts = '--format documentation'
+  t.rspec_opts << ' --color'
+end

data/spec/base_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+RSpec.describe StaticPost::Base do
+  before(:each) do
+    class TestPost < StaticPost::Base; end
+  end
+
+  it '#post_path returns default path' do
+    expect(TestPost.post_path).to eql(File.expand_path('.'))
+  end
+
+  it '#post_path to set post path' do
+    TestPost.post_path("#{__dir__}/fixtures")
+    expect(TestPost.post_path).to eql("#{__dir__}/fixtures")
+  end
+
+  it '#post_path used in class' do
+    class AnotherTestPost < StaticPost::Base
+      post_path 'new_path'
+    end
+    expect(AnotherTestPost.post_path).to eql(File.expand_path('new_path'))
+  end
+
+  it '#post_files' do
+    TestPost.post_path("#{__dir__}/fixtures")
+    expect(TestPost.post_files).to eql(['test_doc.md'])
+  end
+
+  it '#extract_frontmatter' do
+    content = "---\ntitle: Test Post\n---\nDocument Content"
+    parsed_yaml = TestPost.extract_frontmatter(content)
+    expect(parsed_yaml).to eql(title: 'Test Post')
+  end
+
+  it '#post_content' do
+    content = "---\ntitle: Test Post\n---\nDocument Content"
+    parsed_yaml = TestPost.post_content(content)
+    expect(parsed_yaml).to eql("<p>Document Content</p>\n")
+  end
+
+  it '#default_post_path' do
+    expect(TestPost.default_post_path).to eql(File.expand_path('.'))
+  end
+
+  it '#default_post_path with rails' do
+    class App
+      def root
+        'test/path'
+      end
+    end
+    Rails = App.new
+    expected_path = File.expand_path('test/path/app/views/posts')
+    expect(TestPost.default_post_path).to eql(expected_path)
+  end
+end

data/spec/fixtures/test_doc.md

@@ -0,0 +1,7 @@
+---
+title: Test post
+author: Brennan Spellacy
+published: true
+---
+
+# A markdown document

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+Bundler.setup(:default)
+
+require 'pry'
+require 'static_post'

data/static_post.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'static_post/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'static_post'
+  spec.version       = StaticPost::VERSION
+  spec.authors       = ['Brennan Spellacy']
+  spec.email         = ['brennanspellacy@gmail.com']
+  spec.summary       = %q{ActiveRecord like interface to access static markup files.}
+  spec.homepage      = 'https://github.com/bspellio/static_post'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activemodel'
+  spec.add_runtime_dependency 'redcarpet'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: static_post
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brennan Spellacy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brennanspellacy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/static_post.rb
+- lib/static_post/base.rb
+- lib/static_post/version.rb
+- lib/tasks/lint.rake
+- lib/tasks/test.rake
+- spec/base_spec.rb
+- spec/fixtures/test_doc.md
+- spec/spec_helper.rb
+- static_post.gemspec
+homepage: https://github.com/bspellio/static_post
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: ActiveRecord like interface to access static markup files.
+test_files:
+- spec/base_spec.rb
+- spec/fixtures/test_doc.md
+- spec/spec_helper.rb