checklister 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78e466de3b78da29b9b12e95aa4778da7c1efaf5
-  data.tar.gz: 7db9691ccbe80398e451d53ea4c7dbb76166af02
+  metadata.gz: 2c4f8292b102faa5816ffb45782ddea41d891861
+  data.tar.gz: 969a43bbbd9d81141e21ba2fccf6b0eebd8fe41f
 SHA512:
-  metadata.gz: b1b58654ba268f84156437ce39dd08c1aed82478867c50066883f52045daa9a947739747e71d77271ee6b0008e4712ef1200626ea66c9b0fee57ac001e8e4317
-  data.tar.gz: 3ce3e01fbe39938bb457fb2eac7396cb84ba89329d95a6c3d21d8863d1181196cad5396547f4039a1c2df20212e89bab96ca83d3719f7e38d7d01412a6c144c9
+  metadata.gz: 8b59c8df39e808d2e79f8db3b65603b0c882df0cfc44adb0e5b0d2a1d92fa216eeedb99c40a2d9e8fdd26ddadf52a618b9f2dd8a4cdcf01211b683ffa4925dd7
+  data.tar.gz: 1e344a97012d2242142782923a7f3c880d33173778caad9775b881882c19acd6e931ca3426815369254272dd391bea067fd4ddc3a608ced5cd2fc0c5b3022e01

data/CHANGELOG.md

@@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file.
 
 NOTE: the project follows [Semantic Versioning](http://semver.org/).
 
+## 0.9.5 - 2015-09-29
+
+### Added
+
+- [feature] We should be able to override the issue's title we create with a CLI option
+
 ## 0.9.4 - 2015-09-26
 
 ### Fixed

data/README.md

@@ -18,7 +18,7 @@ Checklister is a CLI packaged as a Ruby gem giving you the power to transform an
 A checklist is an ideal tool to help people remembering all of the steps required to accomplish complicated tasks and objectives.
 Using a checklist enforces best practices, even if they seem obvious at first, preventing costly mistakes.
 
-### the checklist manifesto
+### The checklist manifesto
 
 A great book to read for more inspiration about the power of checklist:
 
@@ -74,6 +74,12 @@ Once the file is parsed, a Github issue will be created with its content. In thi
 
 ![Github Issue](http://i.imgur.com/1IwGKaS.png)
 
+Alternatively, you can set a custom title for your issue with the `-t` or `--title` option :
+
+```bash
+$ checklister new --checklist /path/to/simple-checklist.md --title "A custom title"
+```
+
 ## Development Setup
 
 ### Dependencies
@@ -133,7 +139,6 @@ To prepare a release, run `script/release`. This will package a new version of t
 
 - [ ] [improvements] CLI improvements based on first test run with real users
 - [ ] [documentation] Yard documentation updated
-- [ ] [feature] Create a new Issue based on a specific markdown file (remote path)
 - [x] [feature] Connect to github account
 
 ### Wishlist
@@ -142,6 +147,7 @@ To prepare a release, run `script/release`. This will package a new version of t
 - [ ] [feature] Select a milestone from a list populated based on github/gitlab API
 - [ ] [feature] Select a checklist from an history list
 - [ ] [feature] Connect to a bitbucket account
+- [ ] [feature] Create a new Issue based on a specific markdown file (remote path)
 
 ## Authors
 

data/bin/checklister

@@ -116,10 +116,12 @@ end
 desc "Transform a markdown file or url checklist into an actionable issue"
 command :new do |c|
   c.flag [:c,:checklist], desc: "Set the markdown checklist file path", required: true
+  c.flag [:t,:title], desc: "Set a custom issue title"
   c.action do |global_options,options,args|
     api_client = Checklister::Client.new(Checklister.config.to_hash)
     project_client = api_client.project
     checklist_path = options[:checklist]
+    title = options[:title]
 
     puts "* Type some letters of your project's name..."
     project_like = STDIN.gets.chomp
@@ -134,7 +136,7 @@ command :new do |c|
     project = project_client.get(project_id)
     puts "* Creating a checklist issue from #{checklist_path}"
     puts "  to the project: #{project[:name]}"
-    parsed_checklist = Checklister::Parser.new(checklist_path)
+    parsed_checklist = Checklister::Parser.new(checklist_path, title)
     issue = api_client.issue.create(project_id, parsed_checklist.to_params)
     puts "* Issue successfully created!"
   end

data/lib/checklister/parser.rb

@@ -9,19 +9,19 @@ module Checklister
   #
   class Parser
     # @param [String] file_path the path of the markdown file to parse
-    def initialize(file_path)
+    def initialize(file_path, title = nil)
       @file_content = File.open(file_path).read
+      @title = title
     end
 
     # @return [Hash] a hash of params
     def to_params
-      title     = ""
       checklist = []
 
       @file_content.each_line do |line|
         # Extract a title, when we find the first <h1> header
-        if title == "" && line.start_with?("# ")
-          title = line.sub("# ", "").sub("\n", "")
+        if @title.nil? && line.start_with?("# ")
+          @title = line.sub("# ", "").sub("\n", "")
         else
           # Then, keep the text intact until the end of the file
           checklist << line
@@ -29,10 +29,10 @@ module Checklister
       end
 
       # Default title, if no <H1> header found
-      title = "Checklist" if title == ""
+      @title = "Checklist" if @title.nil?
 
       # Return the parsed text as an object
-      { title: title, body: checklist.join }
+      { title: @title, body: checklist.join }
     end
   end
 end

data/lib/checklister/version.rb

@@ -1,3 +1,3 @@
 module Checklister
-  VERSION = "0.9.4"
+  VERSION = "0.9.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checklister
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Benjamin Thouret
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab