openwebslides-converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32e2b829902eba27855f5b7d3be24992607e326721c451953f3592bdc7c17f68
+  data.tar.gz: a94aa71d42dcecbb2b55b06c2ce60fb1481acc333f764357a18de229d516b248
+SHA512:
+  metadata.gz: 17e6ab071e726634cd713f8c9ab389d6778afba918f0af5e16a8e3acb2fddbcada134e467a0543ee0e573729b574423a7cadbe7a2a1354d6ec525d742c894423
+  data.tar.gz: 00ba4632095b4ed1a20e9084c0043ea6b88ba33e63156de02b617655a54e1ebdf58f72b2e0bdab873c4fa1d1648abeee33912133932e2938f7c47c926864601d

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.byebug_history
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# IDE files
+.idea

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: openwebslides-converter Documentation
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - openwebslides-converter.gemspec
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/MixinUsage:
+  Exclude:
+    - spec/spec_helper.rb
+
+Style/NestedParenthesizedCalls:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache:
+  bundler: true
+rvm:
+  - 2.5

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Florian Dejonckheere
+
+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,23 @@
+# Open Webslides Converter [![Build Status](https://secure.travis-ci.org//openwebslides-converter.svg?branch=master)](https://travis-ci.org//openwebslides-converter)
+
+## Description
+
+Converts arbitrary documents to Open Webslides data format.
+
+## Features
+
+## Examples
+
+    require 'openwebslides/converter'
+
+## Requirements
+
+## Install
+
+    $ gem install openwebslides-converter
+
+## Copyright
+
+Copyright (c) 2018 Florian Dejonckheere
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/lib/openwebslides/converter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'openwebslides/converter/helpers/sanitization'
+
+require 'openwebslides/converter/version'
+require 'openwebslides/converter/content'
+require 'openwebslides/converter/result'
+require 'openwebslides/converter/pressbooks'

data/lib/openwebslides/converter/content.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'openwebslides/converter/content/properties/type'
+require 'openwebslides/converter/content/properties/identifier'
+require 'openwebslides/converter/content/properties/container'
+require 'openwebslides/converter/content/properties/metadata'
+require 'openwebslides/converter/content/properties/subable'
+require 'openwebslides/converter/content/properties/text'
+
+require 'openwebslides/converter/content/content_item'
+require 'openwebslides/converter/content/root'
+require 'openwebslides/converter/content/heading'
+require 'openwebslides/converter/content/paragraph'

data/lib/openwebslides/converter/content/content_item.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      class ContentItem
+        include Properties::Identifier
+        include Properties::Type
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/heading.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      class Heading < ContentItem
+        include Properties::Metadata
+        include Properties::Subable
+        include Properties::Text
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/paragraph.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      class Paragraph < ContentItem
+        include Properties::Metadata
+        include Properties::Subable
+        include Properties::Text
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/properties/container.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      module Properties
+        module Container
+          attr_accessor :child_item_ids
+
+          def child_item_ids
+            @child_item_ids ||= []
+          end
+
+          def to_h
+            super.merge :child_item_ids => child_item_ids
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/properties/identifier.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      module Properties
+        module Identifier
+          attr_accessor :id
+
+          def id
+            @id ||= generate_id
+          end
+
+          ##
+          # Convert property to hash
+          #
+          # This is the start of the chain of overridden #to_h methods.
+          # In all subsequent included property modules, #to_h should call
+          # `super.merge :property => property`
+          #
+          def to_h
+            { :id => id }
+          end
+
+          private
+
+          ##
+          # Generate a random 10-digit alphanumeric identifier
+          #
+          # @return [String] identifier
+          #
+          def generate_id
+            r = ('a'..'z').to_a + ('0'..'9').to_a
+
+            10.times.map { r.sample }.join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/properties/metadata.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      module Properties
+        module Metadata
+          attr_accessor :metadata
+
+          def metadata
+            @metadata ||= {
+              :tags => [],
+              :visibility_overrides => {}
+            }
+          end
+
+          def to_h
+            super.merge :metadata => metadata
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/properties/subable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      module Properties
+        module Subable
+          attr_accessor :sub_item_ids
+
+          def sub_item_ids
+            @sub_item_ids ||= []
+          end
+
+          def to_h
+            super.merge :sub_item_ids => sub_item_ids
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/properties/text.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      module Properties
+        module Text
+          attr_accessor :text
+
+          def text
+            @text ||= ''
+          end
+
+          def to_h
+            super.merge :text => text
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/properties/type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      module Properties
+        module Type
+          attr_accessor :type
+
+          def type
+            "contentItemTypes/#{self.class.name.split('::').last.upcase}"
+          end
+
+          def to_h
+            super.merge :type => type
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/content/root.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Content
+      class Root < ContentItem
+        include Properties::Container
+      end
+    end
+  end
+end

data/lib/openwebslides/converter/helpers/sanitization.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenWebslides
+  module Converter
+    module Helpers
+      module Sanitization
+        ##
+        # Sanitize a string
+        # @param [String] text
+        # @return [String]
+        #
+        def sanitize(text)
+          text.gsub(/[[:space:]]+/, ' ')
+              .gsub(/_ _/, '')
+              .strip
+              .gsub(/\A \z/, '')
+        end
+      end
+    end
+  end
+end