rdv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f99ec689d6fad21107ce3b252787078d8075058f
+  data.tar.gz: c800d18457a91002a60a270d21960f619d5ee1bc
+SHA512:
+  metadata.gz: 57abc88789c223c13fa25dc6c9f83ca3826df2159af19c683907f2089c9fe7352bd5328d3cc43a952a88ff9e921de9077069a8c2c9dbacb15a133ec93a2b4e1a
+  data.tar.gz: c16155fa70434704f23dd084dcf569b539abaa982af679e4839d546ea875aa676f42013a3a4ae7c817e434d73291536dfb7b17e4f1880d626f55f92299635383

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Valentin Ballestrino
+
+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,52 @@
+# Rdv
+
+Write plain text and export to Github issues without too much overhead.
+
+## Converter usage
+
+Install the gem :
+
+```bash
+gem install rdv
+```
+
+Then use the provided executable to convert your `.rdv` file :
+
+```bash
+# Syntax : rdv convert <repo> <file_path>
+rdv convert vala/rdv my_file.rdv
+```
+
+## Markup
+
+The file structure needed to be converted is the following :
+
+```text
+Newsletter :
+  - Design newsletter template @vala :
+    * Do this
+    * Do that
+    * etc.
+  - Other issue with labels
+    Do something not being in a list ...
+    blah...
+    tags | at | the | end
+
+Other Theme :
+  -> Issue with a preceding arrow
+    Issue content, can be anything ...
+    tag it | here
+```
+
+What matters :
+* Structure depends on indentation, so Theme / Issue / Content should be respected
+* Collaborator assignment should be at the end of the issue title
+* Labels should be at the end of the issue content, separated by pipes (|)
+
+What is optional :
+* Collaborator assignment is optional
+* Tags are optional
+* Dashes or arrows at the beginning of the Theme or the Issue title will be stripped
+* Colon at the end of Theme or Issue title will be stripped
+* Issue content can contain any Github Issue supported markup
+

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+$:.push File.expand_path("../lib", __FILE__)
+
+Dir[File.expand_path "../lib/tasks/*.rake", __FILE__].each do |file|
+  load file
+end

data/bin/rdv

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$:.push File.expand_path("../../lib", __FILE__)
+
+require "rdv"
+
+Rdv::CLI.start(ARGV)
+

data/lib/rdv.rb

@@ -0,0 +1,6 @@
+module Rdv
+end
+
+require "rdv/parser"
+require "rdv/issues"
+require "rdv/cli"

data/lib/rdv/cli.rb

@@ -0,0 +1,38 @@
+require "thor"
+require "io/console"
+require "rdv/core_ext/string"
+require "octokit"
+
+module Rdv
+  class CLI < Thor
+    desc "convert REPOSITORY FILE", "Converts a .rdv file to Github issues"
+    def convert repo, file
+      puts "Converting file : #{ file } to issues in #{ repo }".yellow
+      repo = repo
+      # Parse themes and issues from input file
+      themes = Parser.parse File.read(file)
+      # Request user's Github credentials to connect to API and build client
+      client = build_github_client
+      # Convert themes to issues and count them
+      issues = Issues.create_from(client, repo, themes)
+      puts "Created #{ issues.length } issues".yellow
+    end
+
+    protected
+
+    def build_github_client
+      puts "Please enter your Github credentials.".green
+      print "Username : ".green
+      username = STDIN.gets.chop
+      print "Password : ".green
+      password = STDIN.noecho(&:gets).chop
+      puts ""
+
+      Octokit::Client.new(login: username, password: password)
+    end
+
+    def create_issues themes
+
+    end
+  end
+end

data/lib/rdv/core_ext/string.rb

@@ -0,0 +1,17 @@
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+end

data/lib/rdv/issues.rb

@@ -0,0 +1,70 @@
+module Rdv
+  class Issues
+    attr_accessor :client, :repo
+
+    def initialize client, repo
+      self.client = client
+      self.repo = repo
+    end
+
+    # Creates issues from the current themes
+    def create_issues themes
+      issues = themes.reduce([]) do |issues, theme|
+        main_label = theme.name
+        issues + theme.list.map do |issue|
+          # Add theme as the first issue's tag
+          issue.tags.unshift(main_label)
+          # Create issue
+          create_issue(issue)
+        end
+      end
+
+      issues.compact
+    end
+
+    def create_issue issue
+      # Serialize the issue to compare it to existing ones
+      serialized = serialize_issue(issue.name, issue.tags)
+      # If issue already exist, don't create it
+      if (existing = existing_issues[serialized])
+        puts ("Issue \"#{ issue.name }\" not created, already exists " +
+          "as ##{ existing.number } / #{ existing.html_url }").red
+        return
+      end
+      # Create issue in repo
+      client.create_issue(repo, issue.name, issue.content, {
+        labels: issue.tags, assignee: issue.user
+      })
+    rescue Octokit::UnprocessableEntity => e
+      data = e.response_body
+      # Tell that issue couldn't be created
+      puts "Couldn't create issue \"#{ issue.name }\", #{ data.message }.".red
+      # Display each field with errors
+      data.errors.each do |error|
+        puts "- #{ error.code } #{ error.field } #{ error.value }".red
+      end
+      # Ensure nil is returned so compacting issues array will remove it
+      # from created ones
+      nil
+    end
+
+    # Retrieves all existing issues for the current repo and stores them
+    # in a hash with the key being some kind of unique identifier
+    #
+    def existing_issues
+      @existing_issues ||=
+        client.list_issues(repo).reduce({}) do |hash, issue|
+          hash[serialize_issue(issue.title, issue.labels.map(&:name))] = issue
+          hash
+        end
+    end
+
+    def serialize_issue title, labels
+      "#{ title }-#{ labels.sort.join(":") }"
+    end
+
+    def self.create_from client, repo, themes
+      new(client, repo).create_issues(themes)
+    end
+  end
+end

data/lib/rdv/object.rb

@@ -0,0 +1,8 @@
+module Rdv
+  module Object
+  end
+end
+
+require "rdv/object/base"
+require "rdv/object/block"
+require "rdv/object/item"

data/lib/rdv/object/base.rb

@@ -0,0 +1,17 @@
+module Rdv
+  module Object
+    class Base
+      def clean str
+        str.gsub(/^\->?\s+/, "").gsub(/(\s*\:)??$/, "").strip
+      end
+
+      def capitalize str
+        str.strip.split(" ").map(&:capitalize).join(" ")
+      end
+
+      def trim_indentation str
+        str.gsub(/^\s{2}/, "")
+      end
+    end
+  end
+end

data/lib/rdv/object/block.rb

@@ -0,0 +1,34 @@
+module Rdv
+  module Object
+    class Block < Base
+      attr_accessor :name, :list, :raw_list
+
+      def initialize header
+        @name = capitalize(header)
+        @raw_list = []
+      end
+
+      def add_line(line)
+        @raw_list << line
+      end
+
+      def build
+        @list = @raw_list.reduce([]) do |list, line|
+          line = trim_indentation(line)
+
+          if line.match(/^[^\s]+/)
+            list << Item.new(line)
+          elsif list.length > 0 && line.length > 0
+            list.last.add_line(line)
+          end
+
+          list
+        end
+
+        @list.each(&:build)
+
+        @name = clean(@name)
+      end
+    end
+  end
+end

data/lib/rdv/object/item.rb

@@ -0,0 +1,44 @@
+module Rdv
+  module Object
+    class Item < Base
+      attr_accessor :name, :content, :raw_content, :user, :tags
+
+      def initialize name
+        @name = name
+        @raw_content = []
+        @tags = []
+      end
+
+      def add_line line
+        @raw_content << line
+      end
+
+      def build
+        # Clean name and store it back
+        @name = clean(@name.strip)
+        # Fetch contents
+        contents = @raw_content.reduce([]) do |list, line|
+          line = trim_indentation(line)
+          list << line unless line.match(/^\s+$/)
+          list
+        end.compact
+
+        if contents.last.scan(/\|/).length > 0
+          @tags = contents.pop.split("|").map do |tag|
+            capitalize(tag)
+          end
+        end
+
+        @content = contents.join("")
+
+        # If a @user tag is found in the issue name, strip it and store it as
+        # the assignee user login
+        if (user = @name.match(/@(\w+)$/))
+          @user = user[1]
+          # Clean username from item name
+          @name = @name.gsub(/@(\w+)$/, "").strip
+        end
+      end
+    end
+  end
+end

data/lib/rdv/parser.rb

@@ -0,0 +1,30 @@
+require "rdv/object"
+
+module Rdv
+  class Parser
+    def self.parse data
+      (@parser ||= self.new).parse(data)
+    end
+
+    def parse data
+      blocks = find_blocks(data)
+      blocks.each(&:build)
+      blocks
+    end
+
+    def find_blocks text
+      text.each_line.reduce([]) do |blocks, line|
+        # If line starts with no tab but has content, we start a new block
+        if line.match(/^[^\s]+/)
+          blocks << Object::Block.new(line)
+        # If we have a content line that starts with one or more tabs, we feed
+        # last existing block, if we already have one
+        elsif line.length > 0 && blocks.length > 0
+          blocks.last.add_line(line)
+        end
+
+        blocks
+      end
+    end
+  end
+end

data/lib/rdv/version.rb

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

data/lib/tasks/rdv_tasks.rake

@@ -0,0 +1,17 @@
+require "rdv"
+
+namespace :rdv do
+  task :example do
+    filepath = File.expand_path "../../../samples/example.rdv", __FILE__
+    parsed = Rdv::Parser.parse(File.read(filepath))
+  end
+
+  task :parse do
+    contents = File.read ENV['FILE']
+    blocks = Rdv::Parser.parse(contents)
+
+    blocks.each do |block|
+      puts block.inspect
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rdv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Valentin Ballestrino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: octokit
+  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'
+description: rdv converts plain text markup into github issues and post them to the
+  desired repository
+email:
+- vala@glyph.fr
+executables:
+- rdv
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/rdv
+- lib/rdv/cli.rb
+- lib/rdv/core_ext/string.rb
+- lib/rdv/issues.rb
+- lib/rdv/object/base.rb
+- lib/rdv/object/block.rb
+- lib/rdv/object/item.rb
+- lib/rdv/object.rb
+- lib/rdv/parser.rb
+- lib/rdv/version.rb
+- lib/rdv.rb
+- lib/tasks/rdv_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://www.glyph.fr
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Small DSL to write issues in plain text
+test_files: []