plantuml_builder 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f69f32a774d145c5795ffe8f749ee9c189f9da503ea697a699c328a2e7b1ccff
-  data.tar.gz: 8f651d9ceadb4ceced50a955b3eba05ead3b8c62d16f1b54ba012b06b2493fc3
+SHA1:
+  metadata.gz: adacb6b59b1b94168c9c92b1c941e4e98d711f42
+  data.tar.gz: 1e1a51cab501b859d19cf6b70d38f3476903d0da
 SHA512:
-  metadata.gz: 1b050f10cde7f32731f8f41e0d9b6b0c680af9559cf3d54421e6ffedd5b412d7f221f0f71cb388a6c84b163b4587ae147feec07b10d090eca7a53070776fe91e
-  data.tar.gz: 678e8a424b4ef20db9d213a01b2482c27328ac42c8c9541537a8e04cba5c931a1c4231fd73e2e3d91f2ae96cd8d733e5814bbc7b0673ddcca4b5c86c8d595ae1
+  metadata.gz: 8a2b6539e65894c0d66f45323b6589996e71c36b3a67abeebc514e6aba57cf26940d7dc0b68105abf71e21534088ab7f1b47b4b4f8a257df0bbdd8f67d24c2e8
+  data.tar.gz: 00be3645ea6b221f78b55a0515f7e6cb45dea4eeeb819b181560d1ebb7f5c403365c978ad9696863c324cca41b65ff32477fc181c1f38e840fca0e0f491f6647

data/README.md

@@ -40,7 +40,7 @@ For example, [sequence diagram](http://plantuml.com/sequence-diagram):
 
 The diagram above will be rendered to:
 
-![](http://www.plantuml.com/plantuml/png/SoWkIImgAStDuL9GI4mkoIzI22rEBG9oW0Z4Kj2rK_2j34ujAijCJbMmKYX8BKhBByg5gCuiIon9HKXpAG11KMf9QL6UGabHAOYVaef5cKDgNWh8HW00)
+![](http://www.plantuml.com/plantuml/png/UDfJK70eBaaiAYdDpU5I08B4v9By8eNGujGYC1S8G6m5NJi5tyhWrAAopEHK1Ik5WjIYjFoYN9YEpBB4abI40gZEejIIqg8yXPAYKeX8IYfMfGwfUIaWsm5R-2hl)
 
 PlantUML web service expects compression of such diagrams into
 it's own format. The diagram above should be converted to
@@ -53,6 +53,29 @@ Using `plantuml_builder` you can fetch rendered diagrams from specified server.
 
 Diagrams could be fetched as SVG, PNG, and TXT (ASCII-art) format.
 
+
+### Using as standalone app
+
+To build one diagram in SVG format from plantuml.com run:
+
+```bash
+$ plantuml_build png source_file.wsd destination_file.svg
+```
+
+If you need build whole directory, specify `-R` flag before source. To build it into PNG diagrams:
+
+```bash
+$ plantuml_build png -R src dest
+```
+
+If you want to use local server as endpoint, specify it with `--endpoint`:
+
+```bash
+$ plantuml_build txt source_file.wsd destination_file.txt --endpoint=http://localhost:8080
+```
+
+### Using as library
+
 First, receive diagram text (from WSD or other file format).
 
 ```ruby
@@ -68,7 +91,7 @@ wsd = <<-WSD
 WSD
 ```
 
-### SVG
+#### SVG
 
 Fetch diagram as SVG:
 
@@ -82,7 +105,7 @@ to store it in version control system. So, `plantuml_builder` fixes it.
 Also, XML comment with description would be removed.
 
 
-### PNG
+#### PNG
 
 Fetch diagram as PNG:
 ```ruby
@@ -90,7 +113,7 @@ PlantumlBuilder::Formats::PNG.new(wsd).load
 => # diagram in PNG
 ```
 
-### TXT (ASCII-art)
+#### TXT (ASCII-art)
 
 ```ruby
 PlantumlBuilder::Formats::TXT.new(wsd).load

data/bin/console

@@ -1,13 +1,9 @@
-#!/usr/bin/env ruby
+#! ruby
 
-require "bundler/setup"
-require "plantuml_builder"
+require 'bundler/setup'
+require 'plantuml_builder'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
+puts "Hello"
 
-require "pry"
+require 'pry'
 Pry.start
-
-require "irb"
-IRB.start

data/bin/plantuml_build

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'docopt'
+
+doc = <<DOCOPT
+plantuml_build allows to build diagrams with PlantUML
+
+Usage:
+  #{__FILE__} (svg|png|txt) <source> <destination> [--endpoint=<endpoint>]
+  #{__FILE__} (svg|png|txt) -R <source_dir> <destination_dir> [--endpoint=<endpoint>]
+  #{__FILE__} -h | --help
+  #{__FILE__} --version
+
+
+Options:
+  -h --help                Show this screen.
+  --version                Show version.
+  -R                       Recursively build folder.
+  --endpoint=<endpoint>    URL of PlantUML endpoint
+
+DOCOPT
+
+CLI = true
+require 'plantuml_builder'
+
+begin
+  args = PlantumlBuilder::Cli::Args.new(Docopt::docopt(doc))
+  PlantumlBuilder::Cli::CliProcessor.new(args).process
+rescue Docopt::Exit => e
+  puts e.message
+end

data/lib/plantuml_builder/cli/args.rb

@@ -0,0 +1,53 @@
+module PlantumlBuilder
+  module Cli
+    class Args
+      def initialize(args_hash)
+        self.args_hash = args_hash
+      end
+
+      def svg?
+        args_hash['svg']
+      end
+
+      def png?
+        args_hash['png']
+      end
+
+      def txt?
+        args_hash['txt']
+      end
+
+      def source
+        args_hash['<source>']
+      end
+
+      def destination
+        args_hash['<destination>']
+      end
+
+      def recursive?
+        args_hash['-R']
+      end
+
+      def source_dir
+        args_hash["<source_dir>"]
+      end
+
+      def destination_dir
+        args_hash["<destination_dir>"]
+      end
+
+      def version?
+        args_hash['--version']
+      end
+
+      def endpoint
+        args_hash['--endpoint']
+      end
+
+      private
+
+      attr_accessor :args_hash
+    end
+  end
+end

data/lib/plantuml_builder/cli/cli_processor.rb

@@ -0,0 +1,81 @@
+module PlantumlBuilder
+  module Cli
+    class CliProcessor
+      def initialize(args_object)
+        self.args_object = args_object
+      end
+
+      def process
+        case
+        when args_object.version?
+          puts_version
+        when args_object.recursive?
+          process_folder
+        else
+          process_file(args_object.source, args_object.destination)
+        end
+      end
+
+      private
+
+      def puts_version
+        puts PlantumlBuilder::VERSION
+        exit(0)
+      end
+
+      def process_folder
+        Dir.glob("#{args_object.source_dir}/**/*.*").each do |file|
+          r = Regexp.new("^#{args_object.source_dir}")
+          dest = file.gsub(r, args_object.destination_dir)
+
+          destdir = File.dirname(dest)
+          FileUtils.mkdir_p(destdir)
+
+          dest_file = "#{destdir}/#{File.basename(dest, File.extname(dest))}.#{ext}"
+
+          process_file(file, dest_file)
+        end
+
+      rescue Errno::EEXIST => e
+        puts e.message
+        exit(1)
+      end
+
+      def process_file(source, dest)
+        uml = File.read(source)
+        f = args_object.endpoint.nil? ? [uml] : [uml, args_object.endpoint]
+
+        File.open(dest, 'w') do |file|
+          file.write(format.new(*f).load)
+        end
+      rescue Errno::ENOENT, Errno::EISDIR, SocketError => e
+        puts e.message
+        exit(1)
+      end
+
+      def format
+        case
+        when args_object.svg?
+          PlantumlBuilder::Formats::SVG
+        when args_object.png?
+          PlantumlBuilder::Formats::PNG
+        when args_object.txt?
+          PlantumlBuilder::Formats::TXT
+        end
+      end
+
+      def ext
+        case
+        when args_object.svg?
+          'svg'
+        when args_object.png?
+          'png'
+        when args_object.txt?
+          'txt'
+        end
+      end
+
+      attr_accessor :args_object
+    end
+  end
+end

data/lib/plantuml_builder/diagram_fetcher.rb

@@ -1,3 +1,5 @@
+require 'net/http'
+
 module PlantumlBuilder
   class DiagramFetcher
     def initialize(url)

data/lib/plantuml_builder/formats.rb

@@ -14,7 +14,9 @@ module PlantumlBuilder
       end
 
       def make_diagram_versionable
-        self.data = data.split('>').join(">\n").gsub(/<!--.*-->/m, '')
+        self.data = data.split('>')
+                        .join(">\n")
+                        .gsub(/<!--[\s\S]*?-->/, '') + '>'
       end
     end
 

data/lib/plantuml_builder/version.rb

@@ -1,3 +1,3 @@
 module PlantumlBuilder
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/plantuml_builder.rb

@@ -7,5 +7,10 @@ require 'plantuml_builder/diagram_fetcher'
 require 'plantuml_builder/format'
 require 'plantuml_builder/formats'
 
+if defined?(CLI)
+  require 'plantuml_builder/cli/args'
+  require 'plantuml_builder/cli/cli_processor'
+end
+
 module PlantumlBuilder
 end

data/plantuml_builder.gemspec

@@ -16,10 +16,11 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = 'plantuml_build'
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'docopt', '~> 0.5.0'
+
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: plantuml_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sergey Vernidub
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-03-09 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +111,8 @@ dependencies:
 description: Gem to build text diagrams with plant uml
 email:
 - svernidub@gmail.com
-executables: []
+executables:
+- plantuml_build
 extensions: []
 extra_rdoc_files: []
 files:
@@ -109,8 +124,11 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/plantuml_build
 - bin/setup
 - lib/plantuml_builder.rb
+- lib/plantuml_builder/cli/args.rb
+- lib/plantuml_builder/cli/cli_processor.rb
 - lib/plantuml_builder/compressor.rb
 - lib/plantuml_builder/deflate.rb
 - lib/plantuml_builder/diagram_fetcher.rb
@@ -139,7 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Gem to build text diagrams with plant uml