rstsyn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2964e205c04edbb3a51a8ff3262adba0c3692fa2
+  data.tar.gz: 36405ce36754f87ea36e0665f9297ef1f7766a2f
+SHA512:
+  metadata.gz: 370673b3695fac1fef96e2f029ab0f35ecc701d587e9713e2c8c912559883e29b4e1ee6de423f79e79ace8fa54aeb37fc5cc3d441836ed22f26c193c4dfadb34
+  data.tar.gz: 08fde15cff0919b2ad41fb2be5bd8d00579a5f123b01e08df805459494e676f3c8b5187a00af45f29dbfb407b6b7a8c0ba9e931fb1111fe1fc102dc0a3b9dfcd

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Stephen Yu
+
+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 @@
+# Rstsyn
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rstsyn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rstsyn
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rstsyn/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,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+ task :default => :spec
+

data/bin/rstsyn

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rstsyn'
+
+Rstsyn::Parser.start($<.to_a).each {|line| puts line}

data/lib/rstsyn.rb

@@ -0,0 +1,80 @@
+require "rstsyn/version"
+
+class String
+  def left_add_spaces val
+    extra_spaces = ''
+    val.times {extra_spaces += ' '}
+    return "#{extra_spaces}#{self.strip}"
+  end
+
+  def left_add_spaces! val
+    self.replace(left_add_spaces val)
+  end
+end
+
+module Rstsyn
+
+  class Parser
+    @min_spaces = 50
+
+    def self.start file_contents
+      converted_file = Array.new
+      potentional_heading = ''
+
+      file_contents.each do |line|
+        line.gsub!(/\t/, '   ')
+
+        if (!potentional_heading.empty?)
+          converted_file << potentional_heading
+
+          if self.isTildeLine? line
+            line = self.createTildeLine(potentional_heading.strip.length)
+          end
+        end
+
+        potentional_heading = ''
+        if self.isCommandwithParameters? line # :command:      Parameters
+          converted_file << self.clean_command(line)
+        elsif self.isAdditionalParameter? line  #                   Additional Paramaters
+          converted_file << self.clean_additional(line)
+        else # Everything Else
+          potentional_heading = line
+        end
+      end
+
+      converted_file << potentional_heading
+
+      return converted_file
+    end
+
+
+    def self.createTildeLine length
+      line = ''
+      length.times {line += '~'}
+      return line
+    end
+
+
+    def self.clean_additional line
+      return line.left_add_spaces!(@min_spaces)
+    end
+
+
+    def self.clean_command line
+      command = /^(?<command>\:\w+\:)\s+(?<params>.+)/.match(line)
+      return "#{command['command'].ljust(@min_spaces)}#{command['params']}"
+    end
+
+    def self.isCommandwithParameters? line
+      return (/^\:\w+\:\s+./ =~ line)
+    end
+
+    def self.isAdditionalParameter? line
+      return (/^\s+./ =~ line)
+    end
+
+    def self.isTildeLine? line
+      return (/^~~/ =~ line)
+    end
+  end
+end

data/lib/rstsyn/version.rb

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

data/rstsyn.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rstsyn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rstsyn"
+  spec.version       = Rstsyn::VERSION
+  spec.authors       = ["Stephen Yu"]
+  spec.email         = ["s.yu@less3.com"]
+  spec.description   = %q{Given an RST file, convert the file so it matches internal format and code style}
+  spec.summary       = %q{Convert an RST file to match an internal format style}
+  spec.homepage      = "https://github.com/stephenyu/rstsyn"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ["rstsyn"]
+  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", "~> 0.0"
+end

data/spec/parser_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+describe Rstsyn do
+
+  it 'valid command line is identified as such' do
+    line = ':precondition:     Name of Precondition'
+
+    expect(Rstsyn::Parser.isCommandwithParameters? line).to be_kind_of(Fixnum)
+    expect(Rstsyn::Parser.isAdditionalParameter? line).to be(nil)
+    expect(Rstsyn::Parser.isTildeLine? line).to be(nil)
+  end
+
+  it 'valid additional parameter to identified as such' do
+    line = '                   Parameter'
+
+    expect(Rstsyn::Parser.isCommandwithParameters? line).to be(nil)
+    expect(Rstsyn::Parser.isAdditionalParameter? line).to be_kind_of(Fixnum)
+    expect(Rstsyn::Parser.isTildeLine? line).to be(nil)
+  end
+
+  it 'valid tildeline to as such' do
+    line = '~~~~~~~~~'
+
+    expect(Rstsyn::Parser.isCommandwithParameters? line).to be(nil)
+    expect(Rstsyn::Parser.isAdditionalParameter? line).to be(nil)
+    expect(Rstsyn::Parser.isTildeLine? line).to be_kind_of(Fixnum)
+  end
+
+  it 'dirty command line is converted cleanly with spaces' do
+    line = ':precondition:     Name of Precondition'
+
+    expect(Rstsyn::Parser.clean_command line).to eq(":precondition:                                    Name of Precondition")
+  end
+
+  it 'dirty additional parameter line is converted cleanly with spaces' do
+    line = '                   Parameter'
+
+    expect(Rstsyn::Parser.clean_additional line).to eq("                                                  Parameter")
+  end
+
+  it 'create TidleLine of certain length' do
+    expect(Rstsyn::Parser.createTildeLine 10).to eq("~~~~~~~~~~")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'rstsyn' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rstsyn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen Yu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-29 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: Given an RST file, convert the file so it matches internal format and
+  code style
+email:
+- s.yu@less3.com
+executables:
+- rstsyn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rstsyn
+- lib/rstsyn.rb
+- lib/rstsyn/version.rb
+- rstsyn.gemspec
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/stephenyu/rstsyn
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Convert an RST file to match an internal format style
+test_files:
+- spec/parser_spec.rb
+- spec/spec_helper.rb