expressir 1.0.0-x86-linux → 1.2.1-x86-linux

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rake/extensiontask"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -9,3 +10,5 @@ task :default => :spec
 GEMSPEC = Gem::Specification.load("expressir.gemspec")
 
 Gem::PackageTask.new(GEMSPEC).define
+
+YARD::Rake::YardocTask.new

data/expressir.gemspec

@@ -31,7 +31,8 @@ Gem::Specification.new do |spec|
   spec.extensions = File.join(*%w(ext express-parser extconf.rb))
 
   spec.add_runtime_dependency "thor", "~> 1.0"
-  spec.add_runtime_dependency "rice", "~> 3"
+  spec.add_runtime_dependency "rice", "~> 4.0.3"
+  spec.add_development_dependency "asciidoctor", "~> 2.0.13"
   spec.add_development_dependency "antlr4-native", "~> 1.1.0"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "pry", "~> 0.12.2"
@@ -40,4 +41,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake-compiler", "~> 1.1"
   spec.add_development_dependency "rake-compiler-dock", "~> 1.1"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9.26"
+  spec.add_development_dependency "webrick", "~> 1.7.0"
 end

data/lib/expressir/express/cache.rb

@@ -5,28 +5,34 @@ require 'expressir/model'
 module Expressir
   module Express
     class Cache
-      def self.to_file(file, content, options = {})
-        root_path = options[:root_path]
-        test_overwrite_version = options[:test_overwrite_version] # don't use, only for tests
-
+      # Save Express model into a cache file
+      # @param file [String] cache file path
+      # @param content [Model::ModelElement] Express model
+      # @param root_path [String] Express repository root path, to be stripped from Express file paths to create a portable cache file
+      # @param test_overwrite_version [String] don't use, only for tests
+      # @return [nil]
+      def self.to_file(file, content, root_path: nil, test_overwrite_version: nil)
         version = test_overwrite_version || VERSION
 
-        cache = Model::Cache.new({
+        cache = Model::Cache.new(
           version: version,
           content: content
-        })
+        )
 
         hash = cache.to_hash(root_path: root_path)
         yaml = YAML.dump(hash)
         yaml_compressed = Zlib::Deflate.deflate(yaml)
 
         File.binwrite(file, yaml_compressed)
+        nil
       end
 
-      def self.from_file(file, options = {})
-        root_path = options[:root_path]
-        test_overwrite_version = options[:test_overwrite_version] # don't use, only for tests
-
+      # Load Express model from a cache file
+      # @param file [String] cache file path
+      # @param root_path [String] Express repository root path, to be prepended to Express file paths if loading a portable cache file
+      # @param test_overwrite_version [String] don't use, only for tests
+      # @return [Model::ModelElement] Express model
+      def self.from_file(file, root_path: nil, test_overwrite_version: nil)
         version = test_overwrite_version || VERSION
 
         yaml_compressed = File.binread(file)