wiki_tips_post 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52dea333415c40693a32086c38d08b529e973a3a
+  data.tar.gz: 9d5fea956cf2f81317c43b7f7e653c96f364f980
+SHA512:
+  metadata.gz: 06f0513f61df1c1db092aa6c75a86bfb355e123e4009b95e6a0bb3a236b963c4afcde03e8f51ade9a680b8ac0607a60c233f67d4f65bb71f1e42929e1f3c0c10
+  data.tar.gz: 90a50e600216ffd2e9e136c531bdab8b1251485aa0444ecbbab43933792fe708c6d0ef8e5580cb29f59dec33533bdbf1c13f669bc65e89dc6385bc3735d3b1fb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wiki_tips_post.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kai Xiang
+
+MIT License
+
+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,31 @@
+# WikiTipsPost
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wiki_tips_post'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wiki_tips_post
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/wiki_tips_post/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:spec]

data/bin/wiki_tips_post

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# vim: ft=ruby
+
+libdir = File.expand_path(File.join(File.dirname(__FILE__), "../lib"))
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "rubygems"
+
+require "wiki_tips_post"
+
+$stdout.sync = true
+
+if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new("1.9.3")
+warn "ERROR: \033[31mRuby version #{RUBY_VERSION} is not supported.\033[0m
+Please install 1.9.3 or later. (See
+    http://docs.cloudfoundry.com/docs/common/install_ruby.html for more
+    information)"
+exit 1
+end
+
+WikiTipsPost::HelperCommand.start(ARGV)

data/lib/wiki_tips_post/helper_command.rb

@@ -0,0 +1,67 @@
+require "mothership"
+require "highline/import"
+
+module WikiTipsPost
+  class HelperCommand < Mothership
+
+    desc "Show Help"
+    input :command, :argument => :optional
+    def help
+      if name = input[:command]
+        if cmd = @@commands[name.gsub("-", "_").to_sym]
+          Mothership::Help.command_help(cmd)
+        else
+          unknown_command(name)
+        end
+      else
+        Mothership::Help.basic_help(@@commands, @@global)
+      end
+    end
+
+    desc "Post tip on cloudops wiki with tags"
+    input (:title) { ask ("the title of the wiki:") }
+    input (:tip) { ask("the tip:") }
+    input (:tags) { ask("the tags for this tip (multiple tags split with ,) :") }
+    input (:file)
+    def post
+      begin
+        tag_array = input[:tags].split(',')
+      rescue StandardError => e
+        puts "Wrong tag format, it should be string split with ,"
+      end
+
+      tip_content = nil
+      if input[:file]
+        tip_content = File.read File.expand_path(input[:file])
+      end
+
+      @wikiposter = WikiPostHelper.new(
+        :title => input[:title],
+        :tips => tip_content || input[:tip],
+        :tags => tag_array
+      )
+
+      puts "\ncloning repo..."
+      @wikiposter.prepare_repo
+
+      puts "\ncreating post..."
+      @wikiposter.create_post
+
+      puts "\npushing repo..."
+      push_repo_success = @wikiposter.push_to_repo
+
+      if push_repo_success
+        puts "\nremoving temporary clone of repo..."
+        @wikiposter.delete_local_repo_clone
+
+        puts "\nsuccessfully added tip!"
+      else
+        puts "\npush was NOT successful"
+
+        exit 1
+      end
+    end
+  end
+
+end
+

data/lib/wiki_tips_post/kernel_wrapper.rb

@@ -0,0 +1,7 @@
+module WikiTipsPost
+  class KernelWrapper
+    def system(*args)
+      Kernel.system(*args)
+    end
+  end
+end

data/lib/wiki_tips_post/version.rb

@@ -0,0 +1,3 @@
+module WikiTipsPost
+  VERSION = "0.0.1"
+end

data/lib/wiki_tips_post/wiki_post_helper.rb

@@ -0,0 +1,80 @@
+require 'tmpdir'
+
+module WikiTipsPost
+
+  WIKI_REPO='git@github.com:pivotal-cf/cloudops-tools.wiki.git'
+  INDEX_PAGE='Cloudops Wiki Tips Index.md'
+
+  class WikiPostHelper
+    def initialize(title: title, tips: tips, tags: tags)
+      @title = title
+      @tips = tips
+      @tags = tags
+      @tmp_dir = Dir.mktmpdir("wiki")
+      @kernel = KernelWrapper.new
+    end
+
+    def prepare_repo
+      git_clone="git clone #{WIKI_REPO} #{@tmp_dir}"
+      @kernel.system(git_clone)
+    end
+
+    def add_new_page
+      File.write(tip_path, @tips) 
+    end
+
+    def link_to_tag(tag)
+      tag_path = File.join(
+        @tmp_dir, 
+        '#' + tag.chomp(' ').reverse.chomp(' ').reverse.gsub(' ','_') + '.md'
+      )
+
+      file_already_exists = File.exists?(tag_path)
+      new_tag_contents = (file_already_exists ? File.read(tag_path).strip : "") + "\n* [[ #{@title} ]]"
+      File.open(tag_path, 'w' ) { |f| f.write new_tag_contents  }
+
+      !file_already_exists
+    end
+
+    def link_to_index(tag)
+      tag_link = "* [[ ##{ tag.gsub(' ', '_') } ]]"
+      index_page_path = File.join(@tmp_dir, INDEX_PAGE)
+      index_page_contents = File.read(index_page_path)
+     
+      unless index_page_contents.index(tag_link)
+        new_index_page_contents = index_page_contents.strip + "\n" + tag_link 
+        content = new_index_page_contents.split("\n").sort
+        content.delete("Category with Tags:")
+        content.insert 0, "Category with Tags:"
+        final_content =  content.join("\n")
+        File.open(index_page_path, 'w') { |f| f.write final_content }
+      
+      end
+    end
+
+    def create_post
+      add_new_page
+      @tags.each do |tg|
+        if link_to_tag(tg)
+          link_to_index(tg)
+        end
+      end
+    end
+
+    def push_to_repo
+      git_push="pushd #{@tmp_dir} && git add . && git commit -m'Added a tip' && git push origin head && popd"
+      @kernel.system(git_push)
+    end
+
+    def delete_local_repo_clone
+      delete_dir="sudo rm -r #{@tmp_dir}"
+      @kernel.system(delete_dir)
+    end
+
+    private
+
+    def tip_path
+      File.join(@tmp_dir, @title + '.md')
+    end
+  end
+end

data/lib/wiki_tips_post.rb

@@ -0,0 +1,8 @@
+require "wiki_tips_post/version"
+require "wiki_tips_post/helper_command"
+require "wiki_tips_post/wiki_post_helper"
+require "wiki_tips_post/kernel_wrapper"
+
+module WikiTipsPost
+  # Your code goes here...
+end

data/spec/fixtures/wiki/index_with_tag/#test_tag1.md

@@ -0,0 +1 @@
+* [[ some_tip ]]

data/spec/fixtures/wiki/index_with_tag/Cloudops Wiki Tips Index.md

@@ -0,0 +1,2 @@
+Category with Tags:
+* [[ #test_tag1 ]]

data/spec/fixtures/wiki/index_without_tag/Cloudops Wiki Tips Index.md

@@ -0,0 +1 @@
+Category with Tags:

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require 'wiki_tips_post'
+require 'yaml'
+
+RSpec.configure do |config|
+  config.failure_color = :magenta
+  config.tty = true
+  config.color = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+def path_for_fixture(fixture_name)
+  fixtures_path = File.expand_path("./fixtures", File.dirname(__FILE__))
+  File.join fixtures_path, fixture_name
+end

data/spec/wiki_tips_post/wiki_post_helper_spec.rb

@@ -0,0 +1,130 @@
+require "spec_helper"
+
+module WikiTipsPost
+
+  describe WikiPostHelper do
+    let!(:tmp_dir) { Dir.mktmpdir }
+    let!(:kernel) { double(:kernel_wrapper) }
+    let(:subject) do
+      described_class.new(
+        :title => 'test title',
+        :tips => 'test tips text',
+        :tags => ['test_tag1', 'test_tag2']
+      )
+    end
+
+    before do
+      allow(KernelWrapper).to receive(:new).and_return(kernel)
+      allow(Dir).to receive(:mktmpdir).and_return(tmp_dir)
+    end
+
+    describe "adding a tip" do
+
+      before do
+        FileUtils.cp_r fixture_path, tmp_dir
+      end
+
+      after do
+        FileUtils.rm_r tmp_dir
+      end
+
+      context 'index without tag' do
+        let(:fixture_path) { path_for_fixture('wiki/index_without_tag/.') }
+
+        it 'prepares the git repo in a tmp directory' do
+          expect(kernel).to receive(:system).with("git clone git@github.com:pivotal-cf/cloudops-tools.wiki.git #{tmp_dir}")
+          subject.prepare_repo
+        end
+
+        it 'adds new pages into the repo with subject and name' do
+          subject.add_new_page
+
+          tip_contents = File.read File.join(tmp_dir, 'test title.md')
+          expect(tip_contents).to eq('test tips text')
+        end
+
+        describe 'creates tag pages' do
+          it 'when there is a space in between' do
+            need_index =  subject.link_to_tag('test tag1')
+            tag_page_contents = File.read File.join(tmp_dir, '#test_tag1.md')
+            expect(tag_page_contents).to eq("\n* [[ test title ]]")
+            expect(need_index).to be(true)
+          end
+
+          it 'when there is a space in front' do
+            need_index =  subject.link_to_tag(' test tag2')
+            tag_page_contents = File.read File.join(tmp_dir, '#test_tag2.md')
+            expect(tag_page_contents).to eq("\n* [[ test title ]]")
+            expect(need_index).to be(true)
+          end
+          
+          it 'when there is a space in back' do
+            need_index =  subject.link_to_tag('test tag3 ')
+            tag_page_contents = File.read File.join(tmp_dir, '#test_tag3.md')
+            expect(tag_page_contents).to eq("\n* [[ test title ]]")
+            expect(need_index).to be(true)
+          end
+        end
+
+        it 'adds the created and sorted tag page to the index page' do
+          expected_content = (<<EOF).chomp
+Category with Tags:
+* [[ #test_taga ]]
+* [[ #test_tagb ]]
+* [[ #test_tagc ]]
+EOF
+
+
+          subject.link_to_index('test tagc')
+          subject.link_to_index('test tagb')
+          subject.link_to_index('test taga')
+
+          index_page_contents = File.read File.join(tmp_dir, INDEX_PAGE)
+          expect(index_page_contents).to eq(expected_content)
+        end
+      end
+
+      context 'index with tag' do
+        let(:fixture_path) { path_for_fixture('wiki/index_with_tag/.') }
+
+        it 'add itself into a existing tag page' do
+          tag_file_path = File.join(tmp_dir, '#test_tag1.md')
+          expect(File.exist?(tag_file_path))
+
+          need_index =  subject.link_to_tag('test_tag1')
+          tag_page_contents = File.read File.join(tmp_dir, '#test_tag1.md')
+          expect(tag_page_contents).to eq("* [[ some_tip ]]\n* [[ test title ]]")
+          expect(need_index).to be(false)
+        end
+
+        it 'adds the created tag page to the index page' do
+          expected_content = "Category with Tags:\n* [[ #test_tag1 ]]\n"
+
+          # Nothing changes before and after
+          index_page_contents = File.read File.join(tmp_dir, INDEX_PAGE)
+          expect(index_page_contents).to eq(expected_content)
+
+          subject.link_to_index('test_tag1')
+
+          index_page_contents = File.read File.join(tmp_dir, INDEX_PAGE)
+          expect(index_page_contents).to eq(expected_content)
+        end
+      end
+    end
+
+
+    describe "pushing to the wiki repo" do
+      it "calls git push from the tmp dir" do
+        expect(kernel).to receive(:system).with("pushd #{tmp_dir} && git add . && git commit -m'Added a tip' && git push origin head && popd")
+        subject.push_to_repo
+      end
+    end
+
+    describe "deleting the temporary repo" do
+      it "calls removes the tmp dir" do
+        expect(kernel).to receive(:system).with(/^(sudo )?rm -r #{tmp_dir}/)
+        subject.delete_local_repo_clone
+      end
+    end
+  end
+end

data/wiki_tips_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 'wiki_tips_post/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wiki_tips_post"
+  spec.version       = WikiTipsPost::VERSION
+  spec.authors       = ["Kai Xiang"]
+  spec.email         = ["kxiang@pivotal.io"]
+  spec.summary       = %q{A tool helps to post tips into cloudops-tools wiki.}
+  spec.description   = %q{And orgnize it with tags.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mothership"
+  spec.add_development_dependency "highline"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: wiki_tips_post
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kai Xiang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: mothership
+  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: highline
+  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: And orgnize it with tags.
+email:
+- kxiang@pivotal.io
+executables:
+- wiki_tips_post
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/wiki_tips_post
+- lib/wiki_tips_post.rb
+- lib/wiki_tips_post/helper_command.rb
+- lib/wiki_tips_post/kernel_wrapper.rb
+- lib/wiki_tips_post/version.rb
+- lib/wiki_tips_post/wiki_post_helper.rb
+- spec/fixtures/wiki/index_with_tag/#test_tag1.md
+- spec/fixtures/wiki/index_with_tag/Cloudops Wiki Tips Index.md
+- spec/fixtures/wiki/index_without_tag/Cloudops Wiki Tips Index.md
+- spec/spec_helper.rb
+- spec/wiki_tips_post/wiki_post_helper_spec.rb
+- wiki_tips_post.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A tool helps to post tips into cloudops-tools wiki.
+test_files:
+- spec/fixtures/wiki/index_with_tag/#test_tag1.md
+- spec/fixtures/wiki/index_with_tag/Cloudops Wiki Tips Index.md
+- spec/fixtures/wiki/index_without_tag/Cloudops Wiki Tips Index.md
+- spec/spec_helper.rb
+- spec/wiki_tips_post/wiki_post_helper_spec.rb