ignoramos 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecbddf5da2625c41dae80c79e62bb08057cc76bd
-  data.tar.gz: cc445af320c1e3863752c56e1cba8c39a00d8cad
+  metadata.gz: b775b7dbb49c4b26b018f96eac206bf6db773142
+  data.tar.gz: 565c0ebf1aaf1c829799331d39341f44d1a4fa7f
 SHA512:
-  metadata.gz: e1f22d1b188129a2ed77725fd103c0313f6380596f0cf2ed24126668e3939b55c9618e0ee47f981e9ea5bc91981870172e44c47b0fdf08115f786c75f9cfa7ab
-  data.tar.gz: a9e3c8bd9843ca5733ca7ac0be25cafda703599164ac6988c193abae4e830d7f2dff604b2ec7bfa6710a79300ff02595d50fed65da7994af19e3161b1a3967bf
+  metadata.gz: 3f51c2fc953aa4f3e94aa6382ceb2317110d16feed96de03940c3a4af866607b985e28c981945cba492d27d7f8cbfd08d3eb1c9339cd4c339e445200e7a33638
+  data.tar.gz: 731ed4f2bce2065b04f5c85ec71881105828d7fd53d858acb12649a53fe60f7453dacc3107308f30b377bf42783020fe82322a5c596d0de95a6a3d8b2263d869

data/README.md

@@ -7,6 +7,7 @@ Status](https://travis-ci.org/achan/ignoramos.svg?branch=master)](https://travis
 Climate](https://codeclimate.com/github/achan/ignoramos/badges/gpa.svg)](https://codeclimate.com/github/achan/ignoramos)
 [![Coverage
 Status](https://img.shields.io/coveralls/achan/ignoramos.svg)](https://coveralls.io/r/achan/ignoramos)
+[![Gem Version](https://badge.fury.io/rb/ignoramos.svg)](http://badge.fury.io/rb/ignoramos)
 
 Getting started
 ===============
@@ -42,7 +43,7 @@ Directory structure
 ```
 
 ```
-$ ignoramos build
+~ $ ignoramos build
 ```
 
 The `build` command is expected to be run at the root directory of the
@@ -57,7 +58,37 @@ How posts are built
  - Render layout as content
  - Render liquid layout (header, footer, content)
 
-After all posts and pages are generated, all remaining files that are not from a
-folder prefixed with `_` will be copied over to `_site`. Custom files take
+After all posts and pages are generated, all remaining files that are not from
+a folder prefixed with `_` will be copied over to `_site`. Custom files take
 precedence, so if your files conflict with generated ones, yours will overwrite
 the generated file.
+
+Microblogging
+===============
+
+Currently, the only external microblogging platform that is supported is Twitter:
+
+```
+~ $ ignoramos tweet "hello world #testing"
+```
+
+This command will post to twitter and create a micro blog in your `_posts`
+directory with filename: `tweet-<twitter_id>.md` with the following contents:
+
+```
+---
+title: tweet 526064479298396163
+timestamp: 2014-10-25T13:35:20-04:00
+layout: tweet
+tweet: https://twitter.com/amoschan/status/526064479298396163
+---
+
+hello world #testing
+```
+
+It is them up to your theme to support the `tweet` layout and optionally use the
+`tweet` variable to link back to Twitter.
+
+For an example of tweets in action, see the [achan/amoschan][ac] theme.
+
+[ac]: https://github.com/achan/amoschan/commit/f15c149e531a35f9c3a38f8c49311a0f3ce7c612

data/ignoramos.gemspec

@@ -4,12 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "ignoramos"
-  spec.version       = "1.0.1"
+  spec.version       = "1.1.0"
   spec.authors       = ["Amos Chan"]
   spec.email         = ["amosschan@gmail.com"]
   spec.summary       = %q{A static site generator for blogs and microposts.}
   spec.description   = spec.summary
-  spec.homepage      = "http://rubygems.org/gems/ignoramos"
+  spec.homepage      = "http://github.com/achan/ignoramos"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/commands/base_tweet_command.rb

@@ -0,0 +1,51 @@
+require 'liquid'
+require 'models/post'
+require 'models/app_config'
+require 'twitter'
+require 'twitter/tweet'
+require 'file_helper'
+
+class BaseTweetCommand
+  attr_reader :file_helper
+
+  TWEET_LAYOUT = <<-LAYOUT
+---
+title: tweet {{tweet.id}}
+timestamp: {{tweet.timestamp}}
+layout: tweet
+tweet: {{tweet.url}}
+---
+
+{{tweet.content}}
+LAYOUT
+
+  def initialize
+    @file_helper = FileHelper.new(Dir.pwd)
+  end
+
+  protected
+  def app_config
+    @config ||= AppConfig.new(file_helper.read_file("_config.yml"))
+  end
+
+  def twitter
+    @twitter ||= Twitter::REST::Client.new do |config|
+      config.consumer_key        = "RerlMuPVgYySMdqvuaBeSw"
+      config.consumer_secret     = "Ccq3hS7fMplpjwCfvpVyPQXV6nPGGGonXSAdmi8ZIc"
+      config.access_token        = app_config.vars['twitter']['access_token']
+      config.access_token_secret = app_config.vars['twitter']['access_token_secret']
+    end
+  end
+
+  def persist_tweet(tweet)
+    file_helper.new_file("_posts/tweet-#{tweet.id}.md",
+                          Liquid::Template.parse(TWEET_LAYOUT).render({
+                            'tweet' => {
+                              'content' => tweet.text,
+                              'id' => tweet.id,
+                              'url' => tweet.uri.to_s,
+                              'timestamp' => DateTime.parse(tweet.created_at.to_s)
+                            }
+                          }))
+  end
+end

data/lib/commands/build_command.rb

@@ -1,5 +1,5 @@
 require 'liquid'
-require 'fileutils'
+require 'file_helper'
 require 'models/post'
 require 'models/page'
 require 'models/app_config'
@@ -7,12 +7,13 @@ require 'models/app_config'
 class BuildCommand
   def initialize(dir = Dir.pwd)
     @dir = dir
+    @file_helper = FileHelper.new(dir)
   end
 
   def execute
     Liquid::Template.file_system = Liquid::LocalFileSystem.new("#{ @dir }/_includes")
     FileUtils.rm_rf("#{ @dir }/_site")
-    mkdir_p("_site")
+    @file_helper.mkdir_p("_site")
 
     generate_pages
     generate_posts
@@ -24,7 +25,7 @@ class BuildCommand
 
   private
   def config
-    @config ||= AppConfig.new(read_file("_config.yml"))
+    @config ||= AppConfig.new(@file_helper.read_file("_config.yml"))
   end
 
   def copy_custom_files
@@ -63,7 +64,7 @@ class BuildCommand
     Dir.foreach("#{ @dir }/#{ dir }") do |item|
       next if item == '.' || item == '..'
 
-      contents = read_file("#{ dir }/#{ item }")
+      contents = @file_helper.read_file("#{ dir }/#{ item }")
       posts << if block_given?
         yield contents
       else
@@ -85,11 +86,11 @@ class BuildCommand
   def generate_dir(posts, template, &block)
     posts.each do |post|
       params = yield post
-      layout = read_file("_layouts/#{ post.vars['layout'] }/#{ template }.liquid")
+      layout = @file_helper.read_file("_layouts/#{ post.vars['layout'] }/#{ template }.liquid")
       post_params = { 'site' => site_config }.merge(params.merge(post.vars))
       post_params['title'] = "#{ post_params['title'] } - #{ config.vars['site']['name'] }"
-      mkdir_p("_site#{ post.path }")
-      new_file("_site#{ post.permalink }",
+      @file_helper.mkdir_p("_site#{ post.path }")
+      @file_helper.new_file("_site#{ post.permalink }",
                Liquid::Template.parse(layout).render(post_params))
     end
   end
@@ -117,11 +118,11 @@ class BuildCommand
   end
 
   def tags_layout
-    @layout ||= read_file("_layouts/default/tags.liquid")
+    @layout ||= @file_helper.read_file("_layouts/default/tags.liquid")
   end
 
   def new_tags_index_file(filename, title, tags)
-    new_file(filename,
+    @file_helper.new_file(filename,
              Liquid::Template.parse(tags_layout).render({
                'title' => title,
                'tags' => tags,
@@ -130,7 +131,7 @@ class BuildCommand
   end
 
   def generate_index_per_tag
-    mkdir_p("_site/tags")
+    @file_helper.mkdir_p("_site/tags")
 
     tags.each do |tag|
       new_tags_index_file("_site/tags/#{ tag['name'] }.html",
@@ -144,14 +145,14 @@ class BuildCommand
                            reverse.
                            first(5)
 
-    layout = read_file("_layouts/default/posts.liquid")
+    layout = @file_helper.read_file("_layouts/default/posts.liquid")
 
-    new_file("_site/index.html",
-             Liquid::Template.parse(layout).render({
-               'posts' => homepage_posts,
-               'title' => config.vars['site']['name'],
-               'site' => site_config
-             }))
+    @file_helper.new_file("_site/index.html",
+                          Liquid::Template.parse(layout).render({
+                            'posts' => homepage_posts,
+                            'title' => config.vars['site']['name'],
+                            'site' => site_config
+                          }))
   end
 
   def site_config
@@ -162,27 +163,11 @@ class BuildCommand
     }
   end
 
-  def mkdir_p(dir)
-    FileUtils.mkdir_p("#{ @dir }/#{ dir }")
-  end
-
-  def new_file(filename, contents)
-    new_post_file = File.new("#{ @dir }/#{ filename }", 'w')
-    new_post_file.write(contents)
-    new_post_file.close
-  end
-
-  def read_file(filename)
-    File.open("#{ @dir }/#{ filename }", 'r') do |file|
-      file.read()
-    end
-  end
-
   def cache
     @cache ||= {}
   end
 
   def template(layout)
-    cache[layout.to_sym] ||= read_file("_layouts/#{ layout }/post.liquid")
+    cache[layout.to_sym] ||= @file_helper.read_file("_layouts/#{ layout }/post.liquid")
   end
 end

data/lib/commands/import_tweet_command.rb

@@ -0,0 +1,11 @@
+require 'commands/base_tweet_command'
+class ImportTweetCommand < BaseTweetCommand
+  def initialize(tweet_id)
+    super()
+    @tweet_id = tweet_id
+  end
+
+  def execute
+    persist_tweet(twitter.status(@tweet_id))
+  end
+end

data/lib/commands/new_command.rb

@@ -1,10 +1,12 @@
 require 'fileutils'
+require 'file_helper'
 
 class NewCommand
   attr_accessor :dir
 
   def initialize(dir)
     @dir = dir.to_s
+    @file_helper = FileHelper.new(dir)
   end
 
   def execute
@@ -21,14 +23,7 @@ class NewCommand
     tagline = 'A short description of my blog'
     desc = 'Site description'
 
-    new_file("_config.yml",
-             "---\nsite:\n  name: #{ blog_name }\n  tagline: #{ tagline }\n  description: #{ desc }")
-  end
-
-  private
-  def new_file(filename, contents)
-    new_post_file = File.new("#{ @dir }/#{ filename }", 'w')
-    new_post_file.write(contents)
-    new_post_file.close
+    @file_helper.new_file("_config.yml",
+                          "---\nsite:\n  name: #{ blog_name }\n  tagline: #{ tagline }\n  description: #{ desc }")
   end
 end

data/lib/commands/tweet_command.rb

@@ -1,64 +1,12 @@
-require 'liquid'
-require 'fileutils'
-require 'models/post'
-require 'models/app_config'
-require 'twitter'
-require 'twitter/tweet'
-
-class TweetCommand
-  LAYOUT = <<-LAYOUT
----
-title: tweet {{tweet.id}}
-timestamp: {{tweet.timestamp}}
-layout: tweet
-tweet: {{tweet.url}}
----
-
-{{tweet.content}}
-LAYOUT
+require 'commands/base_tweet_command'
 
+class TweetCommand < BaseTweetCommand
   def initialize(tweet)
+    super()
     @tweet = tweet
-    @dir = Dir.pwd
   end
 
   def execute
-    tweet = twitter.update(@tweet)
-
-    new_file("_posts/tweet-#{tweet.id}.md",
-             Liquid::Template.parse(LAYOUT).render({
-               'tweet' => {
-                 'content' => @tweet,
-                 'id' => tweet.id,
-                 'url' => tweet.uri.to_s,
-                 'timestamp' => DateTime.now
-               }
-             }))
-  end
-
-  private
-  def app_config
-    @config ||= AppConfig.new(read_file("_config.yml"))
-  end
-
-  def new_file(filename, contents)
-    new_post_file = File.new("#{@dir}/#{filename}", 'w')
-    new_post_file.write(contents)
-    new_post_file.close
-  end
-
-  def read_file(filename)
-    File.open("#{@dir}/#{filename}", 'r') do |file|
-      file.read()
-    end
-  end
-
-  def twitter
-    @twitter ||= Twitter::REST::Client.new do |config|
-      config.consumer_key        = "RerlMuPVgYySMdqvuaBeSw"
-      config.consumer_secret     = "Ccq3hS7fMplpjwCfvpVyPQXV6nPGGGonXSAdmi8ZIc"
-      config.access_token        = app_config.vars['twitter']['access_token']
-      config.access_token_secret = app_config.vars['twitter']['access_token_secret']
-    end
+    persist_tweet(twitter.update(@tweet))
   end
 end

data/lib/file_helper.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+
+class FileHelper
+  attr_reader :dir
+
+  def initialize(dir)
+    @dir = dir
+  end
+
+  def new_file(filename, contents)
+    new_post_file = File.new("#{dir}/#{filename}", 'w')
+    new_post_file.write(contents)
+    new_post_file.close
+  end
+
+  def read_file(filename)
+    File.open("#{dir}/#{filename}", 'r') do |file|
+      file.read()
+    end
+  end
+
+  def mkdir_p(dir)
+    FileUtils.mkdir_p("#{@dir}/#{dir}")
+  end
+end

data/lib/ignoramos.rb

@@ -1,29 +1,30 @@
-require 'commands/new_command'
-require 'commands/build_command'
-require 'commands/tweet_command'
-
 class Ignoramos
   def initialize(args = [])
     command(args).execute
   end
 
-  def command(args)
-    cmd = args[0] unless args.empty?
-
-    if cmd == 'new'
-      NewCommand.new(args[1])
-    elsif cmd == 'build'
-      BuildCommand.new
-    elsif cmd == 'tweet'
-      TweetCommand.new(args[1])
-    else
-      NilCommand.new
-    end
-  end
-
   NilCommand = Struct.new(:args) do
     def execute
       puts 'command not supported'
     end
   end
+
+  private
+  def command(args)
+    cmd = args.slice!(0) unless args.empty?
+    Object.const_get(classify(cmd)).new(*args)
+  rescue NameError
+    NilCommand.new
+  end
+
+
+  def classify(command)
+    snake_class = "#{command}_command"
+    begin
+      require "commands/#{snake_class}"
+    rescue LoadError => e
+      puts e.to_s
+    end
+    snake_class.split('_').collect(&:capitalize).join
+  end
 end

data/rebuild_gem

@@ -1,7 +1,7 @@
 #!/bin/bash
 
-gem uninstall ignoramos-0.0.0.gem
+gem uninstall ignoramos-1.1.0.gem
 gem build ignoramos.gemspec
-gem install ignoramos-0.0.0.gem
+gem install ignoramos-1.1.0.gem
 
 rbenv rehash

data/spec/commands/import_tweet_command_spec.rb

@@ -0,0 +1,12 @@
+require './lib/commands/import_tweet_command'
+require 'shared_examples/tweet_command_examples'
+
+RSpec.describe ImportTweetCommand do
+  describe '#execute' do
+    let(:command) { ImportTweetCommand.new(tweet_id) }
+    let(:client_method) { :status }
+    let(:client_args) { tweet_id }
+
+    it_behaves_like "a command that writes a tweet to file"
+  end
+end

data/spec/commands/tweet_command_spec.rb

@@ -1,59 +1,12 @@
-require './lib/commands/new_command'
-require './lib/commands/tweet_command'
-require 'fakefs/spec_helpers'
-require 'timecop'
+require 'commands/tweet_command'
+require 'shared_examples/tweet_command_examples'
 
 RSpec.describe TweetCommand do
   describe '#execute' do
-    include FakeFS::SpecHelpers
+    let(:command) { TweetCommand.new(tweet) }
+    let(:client_method) { :update }
+    let(:client_args) { tweet }
 
-    let(:command) { TweetCommand.new('testdir') }
-    let(:tweet) { 'this is a tweet' }
-    let(:tweet_id) { '525483671584002048' }
-    let(:tweet_url) { "https://twitter.com/amoschan/status/#{tweet_id}" }
-    let(:tweet_post) do
-<<-TWEET
----
-title: tweet #{tweet_id}
-timestamp: #{now}
-layout: tweet
-tweet: #{tweet_url}
----
-
-this is a tweet
-TWEET
-    end
-
-    let(:now) { DateTime.now }
-
-    let(:created_tweet) do
-      double()
-    end
-
-    before do
-      created_tweet.stub(:uri).and_return(URI(tweet_url))
-      created_tweet.stub(:id).and_return(tweet_id)
-      allow_any_instance_of(AppConfig).
-          to receive(:vars).and_return({
-        'twitter' => { 'access_token' => 'token',
-                       'access_token_secret' => 'secret' }
-      })
-
-      expect_any_instance_of(Twitter::REST::Client).
-          to receive(:update).with(tweet).and_return(created_tweet)
-
-      Timecop.freeze do
-        NewCommand.new('testdir').execute
-        Dir.chdir('testdir')
-        TweetCommand.new('this is a tweet').execute
-        now
-      end
-    end
-
-    it 'creates new tweet' do
-      File.open("_posts/tweet-#{tweet_id}.md", 'r') do |file|
-        expect(file.read()).to eq(tweet_post)
-      end
-    end
+    it_behaves_like "a command that writes a tweet to file"
   end
 end

data/spec/ignoramos_spec.rb

@@ -0,0 +1,68 @@
+require 'commands/build_command'
+require 'commands/tweet_command'
+require 'commands/new_command'
+require 'commands/import_tweet_command'
+require 'pry'
+require 'ignoramos'
+
+RSpec.describe Ignoramos do
+  shared_examples_for "a command executer" do
+    let(:command) { double() }
+
+    it 'instantiates a command and calls execute' do
+      expect(command_class).
+          to receive(:new).with(*args[1..-1]).and_return(command)
+      expect(command).to receive(:execute)
+
+      Ignoramos.new(args)
+    end
+  end
+
+  shared_examples_for 'a command executer with no args' do
+    let(:command) { double() }
+
+    it 'instantiates a command and calls execute' do
+      expect(command_class).to receive(:new).with(no_args).and_return(command)
+      expect(command).to receive(:execute)
+
+      Ignoramos.new(args)
+    end
+  end
+
+  describe '#initialize' do
+    describe 'when the command passed is "new"' do
+      let(:args) { ['new', 'tempsite'] }
+      let(:command_class) { NewCommand }
+
+      it_behaves_like "a command executer"
+    end
+
+    describe 'when the command passed is "tweet"' do
+      let(:args) { ['tweet', 'this is a tweet'] }
+      let(:command_class) { TweetCommand }
+
+      it_behaves_like "a command executer"
+    end
+
+    describe 'when the command passed is "build"' do
+      let(:args) { ['build'] }
+      let(:command_class) { BuildCommand }
+
+      it_behaves_like "a command executer with no args"
+    end
+
+    describe 'when the command passed is "import_tweet"' do
+      let(:args) { ['import_tweet', '1234'] }
+      let(:command_class) { ImportTweetCommand }
+
+      it_behaves_like "a command executer"
+    end
+
+    describe 'when the command is unsupported' do
+      let(:args) { ['asdasfsdfsd'] }
+      let(:command_class) { Ignoramos::NilCommand }
+
+      it_behaves_like "a command executer with no args"
+    end
+  end
+end

data/spec/shared_examples/tweet_command_examples.rb

@@ -0,0 +1,58 @@
+require './lib/commands/new_command'
+require 'fakefs/spec_helpers'
+require 'timecop'
+
+shared_examples_for "a command that writes a tweet to file" do
+  include FakeFS::SpecHelpers
+
+  let(:tweet) { 'this is a tweet' }
+  let(:tweet_id) { '525483671584002048' }
+  let(:tweet_url) { "https://twitter.com/amoschan/status/#{tweet_id}" }
+  let(:tweet_post) do
+<<-TWEET
+---
+title: tweet #{tweet_id}
+timestamp: #{now}
+layout: tweet
+tweet: #{tweet_url}
+---
+
+#{tweet}
+TWEET
+  end
+
+  let(:now) { DateTime.now }
+  let(:now_time) { Time.now }
+
+  let(:remote_tweet) do
+    double()
+  end
+
+  before do
+    Timecop.freeze do
+      remote_tweet.stub(:uri).and_return(URI(tweet_url))
+      remote_tweet.stub(:id).and_return(tweet_id)
+      remote_tweet.stub(:created_at).and_return(now_time)
+      remote_tweet.stub(:text).and_return(tweet)
+      allow_any_instance_of(AppConfig).
+          to receive(:vars).and_return({
+        'twitter' => { 'access_token' => 'token',
+                       'access_token_secret' => 'secret' }
+      })
+
+      expect_any_instance_of(Twitter::REST::Client).
+          to receive(client_method).with(client_args).and_return(remote_tweet)
+
+      NewCommand.new('testdir').execute
+      Dir.chdir('testdir')
+      command.execute
+      now
+    end
+  end
+
+  it 'creates new tweet' do
+    File.open("_posts/tweet-#{tweet_id}.md", 'r') do |file|
+      expect(file.read()).to eq(tweet_post)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ignoramos
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Amos Chan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-25 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,22 +56,28 @@ files:
 - Rakefile
 - bin/ignoramos
 - ignoramos.gemspec
+- lib/commands/base_tweet_command.rb
 - lib/commands/build_command.rb
+- lib/commands/import_tweet_command.rb
 - lib/commands/new_command.rb
 - lib/commands/tweet_command.rb
+- lib/file_helper.rb
 - lib/ignoramos.rb
 - lib/models/app_config.rb
 - lib/models/page.rb
 - lib/models/post.rb
 - rebuild_gem
 - spec/commands/build_command_spec.rb
+- spec/commands/import_tweet_command_spec.rb
 - spec/commands/new_command_spec.rb
 - spec/commands/tweet_command_spec.rb
+- spec/ignoramos_spec.rb
 - spec/models/app_config_spec.rb
 - spec/models/page_spec.rb
 - spec/models/post_spec.rb
+- spec/shared_examples/tweet_command_examples.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/ignoramos
+homepage: http://github.com/achan/ignoramos
 licenses:
 - MIT
 metadata: {}
@@ -97,9 +103,12 @@ specification_version: 4
 summary: A static site generator for blogs and microposts.
 test_files:
 - spec/commands/build_command_spec.rb
+- spec/commands/import_tweet_command_spec.rb
 - spec/commands/new_command_spec.rb
 - spec/commands/tweet_command_spec.rb
+- spec/ignoramos_spec.rb
 - spec/models/app_config_spec.rb
 - spec/models/page_spec.rb
 - spec/models/post_spec.rb
+- spec/shared_examples/tweet_command_examples.rb
 - spec/spec_helper.rb