jekyll-snippets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b05ebbc313269c2d81cf11d180bf054e6a85580
+  data.tar.gz: 09781e3cd595487c5c64396b5708fef48f24ee98
+SHA512:
+  metadata.gz: a099f7cf2076c046e0e7390795f9c4bb88e75ea6af88b4222152078e1129b64b5e97e4f3d4c1eac53f34f18066a94196c382393504df5643057afd2a890532c6
+  data.tar.gz: a82c90c4f7a102df6a4b6a6f4ee933fcd5d1155a3f38a653e6d058e7ebe2008f96436ace2dd2ff1b97f99755b6f0ce2c7c4175a364b84b82cb3bb93c8e7f579b

data/.gitignore

@@ -0,0 +1 @@
+.ruby-*

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm: 2.2.1
+script: bundle exec rspec spec

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    jekyll-snippets (0.0.0)
+      jekyll (>= 2.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    blankslate (2.1.2.4)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    classifier-reborn (2.0.3)
+      fast-stemmer (~> 1.0)
+    coderay (1.1.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1.1)
+    colorator (0.1)
+    diff-lcs (1.2.5)
+    execjs (2.6.0)
+    fast-stemmer (1.0.2)
+    ffi (1.9.10)
+    hitimes (1.2.2)
+    jekyll (2.5.3)
+      classifier-reborn (~> 2.0)
+      colorator (~> 0.1)
+      jekyll-coffeescript (~> 1.0)
+      jekyll-gist (~> 1.0)
+      jekyll-paginate (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 2.6.1)
+      mercenary (~> 0.3.3)
+      pygments.rb (~> 0.6.0)
+      redcarpet (~> 3.1)
+      safe_yaml (~> 1.0)
+      toml (~> 0.1.0)
+    jekyll-coffeescript (1.0.1)
+      coffee-script (~> 2.2)
+    jekyll-gist (1.3.4)
+    jekyll-paginate (1.1.0)
+    jekyll-sass-converter (1.3.0)
+      sass (~> 3.2)
+    jekyll-watch (1.2.1)
+      listen (~> 2.7)
+    kramdown (1.8.0)
+    liquid (2.6.3)
+    listen (2.10.1)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    mercenary (0.3.5)
+    method_source (0.8.2)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    posix-spawn (0.3.11)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pygments.rb (0.6.3)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (3.3.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    sass (3.4.18)
+    slop (3.6.0)
+    timers (4.0.1)
+      hitimes
+    toml (0.1.2)
+      parslet (~> 1.5.0)
+    yajl-ruby (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  jekyll-snippets!
+  pry
+  rake
+  rspec

data/README.md

@@ -0,0 +1,10 @@
+# Jekyll-Snippets
+
+![Build Status](https://travis-ci.org/yez/jekyll-snippets.svg?branch=master)
+
+Post archive page plugin for Jekyll powered blogs
+
+### Installation
+
+### Configuration
+

data/jekyll-snippets.gemspec

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__)) unless $LOAD_PATH.include?(File.dirname(__FILE__))
+
+require './version'
+
+Gem::Specification.new do |s|
+  s.name          = 'jekyll-snippets'
+  s.version       = Jekyll::JekyllSnippets::VERSION
+  s.summary       = %q{Generates archive snippets for a jekyll site}
+  s.description   = %q{This plugin will generate an html file that can be accessible by default at /archives/index.html for a jekyll static blog. Additional CSS will be required to acheive the desired look and feel.}
+  s.authors       = ['Jake Yesbeck']
+  s.email         = 'yesbeckjs@gmail.com'
+  s.homepage      = %q{https://github.com/yez/jekyll-snippets}
+  s.license       = 'MIT'
+
+  s.require_paths = ['lib']
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = s.files.grep(/^spec\//)
+
+  s.required_ruby_version = '>= 2.0.0'
+  s.add_dependency 'jekyll', '>= 2.5'
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
+end

data/jekyll-snippets.rb

@@ -0,0 +1,11 @@
+require 'jekyll'
+require './lib/config'
+require './lib/formatter'
+require './lib/renderer'
+require './lib/snippet'
+require './lib/snippet_generator'
+
+module Jekyll
+  module JekyllSnippets
+  end
+end

data/lib/config.rb

@@ -0,0 +1,15 @@
+module Jekyll
+  module JekyllSnippets
+    class Config
+      attr_accessor :output_dir, :output_file
+    end
+
+    def self.config(&config_blok)
+      @config ||= Config.new
+    end
+
+    def self.configure
+      yield config
+    end
+  end
+end

data/lib/formatter.rb

@@ -0,0 +1,10 @@
+require 'jekyll'
+
+module Jekyll
+  module JekyllSnippets
+    class Formatter
+      include Jekyll::Filters
+      include Liquid::StandardFilters
+    end
+  end
+end

data/lib/renderer.rb

@@ -0,0 +1,22 @@
+module Jekyll
+  module JekyllSnippets
+    class Renderer
+      attr_reader :snippets
+
+      def initialize(snippets)
+        @snippets = snippets
+      end
+
+      def render(output_destination)
+        template = Liquid::Template.parse(File.read(template_file))
+        template.render({ 'snippets' => @snippets })
+      end
+
+      private
+
+      def template_file
+        File.expand_path('../../views/index.html.liquid', __FILE__)
+      end
+    end
+  end
+end

data/lib/snippet.rb

@@ -0,0 +1,34 @@
+module Jekyll
+  module JekyllSnippets
+    class Snippet
+      attr_reader :date, :content, :url
+
+      def initialize(post, formatter)
+        @post = post
+        @formatter = formatter
+
+        @date = formatted_date
+        @content = truncated_content
+        @url = post.url
+      end
+
+      def render
+        template = Liquid::Template.parse(File.read(partial))
+        template.render({ 'date' => date, 'content' => content, 'url' => url })
+      end
+
+      def truncated_content
+        stripped = @formatter.strip_html(@post.content)
+        @formatter.truncate(stripped, 200, '...')
+      end
+
+      def formatted_date
+        @formatter.date_to_string(@post.date)
+      end
+
+      def partial
+        File.expand_path('snippet.html.liquid', File.dirname(__FILE__) + '/../views')
+      end
+    end
+  end
+end

data/lib/snippet_generator.rb

@@ -0,0 +1,46 @@
+require_relative './snippet'
+require_relative './formatter'
+require_relative './renderer'
+
+module Jekyll
+  module JekyllSnippets
+    class SnippetGenerator < Jekyll::Generator
+      attr_reader :site
+
+      def generate(site)
+        @site = site
+
+        make_dir
+
+        renderer = JekyllSnippets::Renderer.new(snippets)
+        renderer.render(output_destination)
+      end
+
+      private
+
+      def snippets
+        @site.posts.map do |post|
+          Snippet.new(post, Formatter.new).render
+        end
+      end
+
+      def output_destination
+        "#{ output_dir }/#{ output_file }"
+      end
+
+      def make_dir
+        Dir.mkdir(output_dir) unless Dir.exist?(output_dir)
+      end
+
+      def output_file
+        JekyllSnippets.config.output_file ||
+          'index.html'
+      end
+
+      def output_dir
+        JekyllSnippets.config.output_dir ||
+          site.in_source_dir('/archives/')
+      end
+    end
+  end
+end

data/spec/lib/formatter_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../spec_helper'
+
+module Jekyll
+  module JekyllSnippets
+    describe Formatter do
+      it 'includes jekyll filters' do
+        expect(described_class.ancestors).to include(Jekyll::Filters)
+      end
+
+      it 'includes liquid standard filters' do
+        expect(described_class.ancestors).to include(Liquid::StandardFilters)
+      end
+    end
+  end
+end

data/spec/lib/renderer_spec.rb

@@ -0,0 +1,30 @@
+require_relative '../spec_helper'
+module Jekyll
+  module JekyllSnippets
+    describe Renderer do
+      describe '#initialize' do
+        it 'sets the instance variable @snippets' do
+          instance = described_class.new(anything)
+          expect(instance.instance_variable_get(:@snippets)).to_not be_nil
+        end
+
+        it 'responds to snippets' do
+          expect(described_class.new(anything)).to respond_to(:snippets)
+        end
+      end
+
+      describe '#render' do
+        let(:formatter) { Formatter.new }
+        let(:post) { TestPost.new }
+        let(:snippets) { 3.times.map { Snippet.new(post, formatter) } }
+
+        subject { described_class.new(snippets) }
+
+        it 'loads the index file and renders it' do
+          expect(Liquid::Template).to receive(:parse).with(File.read(File.expand_path('../../../views/index.html.liquid', __FILE__))).and_call_original
+          subject.render('test_file')
+        end
+      end
+    end
+  end
+end

data/spec/lib/snippet_generator_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../spec_helper'
+
+module Jekyll
+  module JekyllSnippets
+    describe SnippetGenerator do
+      describe '#generate' do
+        subject { described_class.new }
+
+        before do
+          allow(subject).to receive(:snippets) { [] }
+          allow(subject).to receive(:make_dir)
+          allow(subject).to receive(:output_dir) { '' }
+          allow_any_instance_of(JekyllSnippets::Renderer).to receive(:render)
+        end
+
+        it 'sets the site instance variable' do
+          subject.generate(anything)
+          expect(subject.instance_variable_get(:@site)).to_not be_nil
+        end
+      end
+    end
+  end
+end

data/spec/lib/snippet_spec.rb

@@ -0,0 +1,77 @@
+require_relative '../spec_helper'
+
+module Jekyll
+  module JekyllSnippets
+    describe Snippet do
+      post = Struct.new('Post', :date_to_string)
+
+      let(:formatter) { Formatter.new }
+
+      subject { described_class.new(post, formatter) }
+
+      before do
+        allow(formatter).to receive(:date_to_string)
+        allow(post).to receive(:content)
+        allow(post).to receive(:url)
+      end
+
+      describe '#initialize' do
+        context 'instance variables' do
+          before do
+            allow_any_instance_of(described_class).to receive(:formatted_date) { anything }
+            allow_any_instance_of(described_class).to receive(:truncated_content) { anything }
+            allow(post).to receive(:url) { anything }
+          end
+
+          it 'sets the proper instance variables' do
+            expect(subject.instance_variable_get(:@date)).to_not be_nil
+            expect(subject.instance_variable_get(:@content)).to_not be_nil
+            expect(subject.instance_variable_get(:@url)).to_not be_nil
+          end
+        end
+
+        context 'methods' do
+          it 'calls the proper methods' do
+            expect_any_instance_of(described_class).to receive(:formatted_date)
+            expect_any_instance_of(described_class).to receive(:truncated_content)
+            expect(post).to receive(:url)
+
+            subject
+          end
+        end
+      end
+
+      describe '!#truncated_content' do
+        let(:content) { 'this is some <b>content</b>' }
+        let(:content_without_html) { 'this is some content' }
+
+        before do
+          allow_any_instance_of(described_class).to receive(:formatted_date) { anything }
+          allow(post).to receive(:url) { anything }
+          allow(post).to receive(:content) { content }
+        end
+
+        it 'strips html and truncates' do
+          expect(formatter).to receive(:strip_html).with(content) { content_without_html }
+          expect(formatter).to receive(:truncate).with(content_without_html, 200, '...')
+          subject
+        end
+      end
+
+      describe '!#partial' do
+        before do
+          allow(post).to receive(:date)
+        end
+
+        it 'renders the correct partial' do
+          partial = File.expand_path('snippet.html.liquid', File.dirname(__FILE__) + '../../../views')
+          expect(subject.send(:partial)).to eq(partial)
+        end
+
+        it 'the file exists' do
+          expect(File.exists?(subject.send(:partial))).to eq(true)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'pry'
+require_relative '../jekyll-snippets'
+
+class TestPost
+  def url; end
+
+  def content; end
+
+  def date
+    Time.now
+  end
+end

data/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module JekyllSnippets
+    VERSION = '0.0.1'.freeze
+  end
+end

data/views/index.html.liquid

@@ -0,0 +1,5 @@
+<div class='snippets-container'>
+  {% for snippet in snippets %}
+    {% include 'snippet' url=snippet.url date=snippet.date content=snippet.content %}
+  {% endfor %}
+</div>

data/views/snippet.html.liquid

@@ -0,0 +1,6 @@
+<div class='snippet'>
+  <a href="{{ url }}" class='link'>
+    <span class='title'>{{ title }} - {{ date }}</span>
+    <div class='content'>{{ content }}</div>
+  </a>
+</div>

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-snippets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jake Yesbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+description: This plugin will generate an html file that can be accessible by default
+  at /archives/index.html for a jekyll static blog. Additional CSS will be required
+  to acheive the desired look and feel.
+email: yesbeckjs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- jekyll-snippets.gemspec
+- jekyll-snippets.rb
+- lib/config.rb
+- lib/formatter.rb
+- lib/renderer.rb
+- lib/snippet.rb
+- lib/snippet_generator.rb
+- spec/lib/formatter_spec.rb
+- spec/lib/renderer_spec.rb
+- spec/lib/snippet_generator_spec.rb
+- spec/lib/snippet_spec.rb
+- spec/spec_helper.rb
+- version.rb
+- views/index.html.liquid
+- views/snippet.html.liquid
+homepage: https://github.com/yez/jekyll-snippets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Generates archive snippets for a jekyll site
+test_files:
+- spec/lib/formatter_spec.rb
+- spec/lib/renderer_spec.rb
+- spec/lib/snippet_generator_spec.rb
+- spec/lib/snippet_spec.rb
+- spec/spec_helper.rb