otrs-sopm 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2265650b8a30d454e0c1a06e31873e75f45c168b
-  data.tar.gz: f96228d95f0a98cb3a88cd1968fec04882f7ccc4
+  metadata.gz: 91edf1fcda4ff9b663c3225b502c43ed8a8c9df1
+  data.tar.gz: e7ecd8115331276d98e2062f604603a2c36a6bcf
 SHA512:
-  metadata.gz: dadf68cd3c616ab1160c44bcc24eb7339a53f61709caa03f47a7e381a2a8e0c743fa977984e2ffe903d48388d90a8806775b1ccd1ef06606fc4b3c4ae2ed34a4
-  data.tar.gz: 09683ea7295d64c279faad5379abd886e9ea6ffb344bfc7be5261ea5bec1b3aa11bf6d5d333e0484484668d4f54cb76dc2fbde87e27fd7c03b7d2796f20ccf95
+  metadata.gz: cc8a21b952e7e91001c443224001227c3cfcd9fe5a4f96906e64f04f904c8653b5d53998881dca13ff4748ee0b9260b75add3901e0bcd6f575eb080b40243e96
+  data.tar.gz: 0973e8f5392698ca4ce3589b3b53601df23582a72c0f9d1e0ede5f70c95e78a4b0d90a626a1f73b429831c51e64da871c671077c8d00b2735d57e8346dacf82d

data/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.rubocop.yml

@@ -1,6 +1,7 @@
 # Default enabled cops
 # https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
 
+# Zammad StyleGuide
 Metrics/LineLength:
   Description: 'Limit lines to 80 characters.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
@@ -20,8 +21,13 @@ Style/IfUnlessModifier:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier'
   Enabled: false
 
-Style/TrailingComma:
-  Description: 'Checks for trailing comma in parameter lists and literals.'
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
   Enabled: false
 
@@ -37,12 +43,6 @@ Style/SpaceAfterMethodName:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces'
   Enabled: false
 
-Style/SingleSpaceBeforeFirstArg:
-  Description: >-
-                 Checks that exactly one space is used between a method name
-                 and the first argument for method calls without parentheses.
-  Enabled: false
-
 Style/LeadingCommentSpace:
   Description: 'Comments should start with a space.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-space'
@@ -168,12 +168,3 @@ Metrics/CyclomaticComplexity:
                  A complexity metric that is strongly correlated to the number
                  of test cases needed to validate a method.
   Enabled: false
-
-Metrics/BlockNesting:
-  Description: 'Avoid excessive block nesting'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'
-  Enabled: false
-
-Metrics/ModuleLength:
-  Description: 'Avoid modules longer than 100 lines of code.'
-  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 1.9.3

data/README.md

@@ -2,6 +2,7 @@
 
 This gem provides a class to parse, manipulate and store SOPM files and create OPM strings from them.
 
+Current build state: ![Build Status](https://travis-ci.org/znuny/otrs-sopm.svg?branch=master)
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,6 +24,8 @@ Or install it yourself as:
 First create an instance via passing the location to the .sopm file.
 
 ```ruby
+require 'otrs/sopm'
+
 sopm = OTRS::SOPM.new 'path/to/Znuny4OTRS-Package.sopm'
 ```
 
@@ -34,6 +37,18 @@ A new version can be created via passing the wanted version number and a changel
 sopm_hash_structure = sopm.version('1.0.1', 'Created first bug fix.')
 ```
 
+### Delete version
+
+A version can be deleted via passing the wanted version number or nothing for deleting the latest. If the current version gets deleted, the version number gets replaced by the previous one if one exisits:
+
+```ruby
+sopm_hash_structure = sopm.version_delete('1.0.1')
+
+# or for the latest
+
+sopm_hash_structure = sopm.version_delete()
+```
+
 ### Add build information
 
 It's recommended to add the build host and build date to the OPM file. Give the build host as a parameter with to add the build information via:
@@ -94,10 +109,6 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Tests
-
-The tests are currently in an external project since there is business logic in them. In future releases this tests will be added to this gem repository as it should be.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/znuny/otrs-sopm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -1,2 +1,8 @@
 require 'bundler/gem_tasks'
-task default: :spec
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end

data/lib/otrs/sopm/version.rb

@@ -2,6 +2,6 @@
 class OTRS
   # Contains just the version number, bundler / gem default design
   class SOPM
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'.freeze
   end
 end

data/lib/otrs/sopm.rb

@@ -32,6 +32,10 @@ class OTRS
     # @return (see #parse)
     def version(version, change_log)
 
+      fail ArgumentError, 'Version has to be a string' unless version.is_a? String
+      fail ArgumentError, 'Version has to be in the format "1.0.1" for releases or "1.0.1.1" for test releases' unless /\A\d+(?:\.\d+){2,3}\z/ =~ version
+      fail ArgumentError, 'Change_log hast to be a string' unless change_log.is_a? String
+
       # change Version
       @sopm.xpath('/otrs_package/Version').children[0].content = version
 
@@ -49,7 +53,7 @@ class OTRS
 
       new_change_log_entry            = Nokogiri::XML::Node.new 'ChangeLog', sopm
       new_change_log_entry['Version'] = version
-      new_change_log_entry['Date']    = Time.zone.now
+      new_change_log_entry['Date']    = Time.now
       new_change_log_entry.content    = change_log
 
       change_log_nodes.first.previous = new_change_log_entry.to_xml + "\n    "
@@ -57,11 +61,47 @@ class OTRS
       store
     end
 
+    # Removes the given or latest (if no parameter is passed) version and removes the matching changelog from the SOPM file.
+    #
+    # @param version [String, nil] the version number or nil if the latest should get removed.
+    # @return (see #parse)
+    def version_delete(version_delete = nil)
+
+      change_log_nodes = @sopm.xpath('/otrs_package/ChangeLog')
+
+      if !version_delete || version_delete == @structure['version']
+
+        new_version = nil
+        if change_log_nodes.length > 0
+          @sopm.xpath('/otrs_package/ChangeLog').first.remove
+          if @sopm.xpath('/otrs_package/ChangeLog').length > 0
+            new_version = @sopm.xpath('/otrs_package/ChangeLog').first['Version']
+          end
+        end
+
+        @sopm.xpath('/otrs_package/Version').children[0].content = new_version
+      elsif change_log_nodes.length > 0
+
+        change_log_nodes.each { |change_log_node|
+
+          next if !change_log_node['Version'].is_a? String
+          next if change_log_node['Version'] != version_delete
+
+          change_log_node.remove
+
+          break
+        }
+      end
+
+      store
+    end
+
     # Adds the buildhost and builddate to the SOPM file.
     #
     # @param build_host [String] build host on which the OPM file was created.
     # @return (see #parse)
     def add_build_information(build_host)
+      fail ArgumentError, 'Build_host has to be a string' unless build_host.is_a? String
 
       # add BuildHost
       if @sopm.xpath('/otrs_package/BuildHost').children.length == 0
@@ -345,6 +385,10 @@ class OTRS
         @structure[ 'database_' + block_type ] = []
         intro_block_nodes.each { |intro_block_node|
 
+          next if !intro_block_node
+          next if !intro_block_node.children.is_a?(Array)
+          next if intro_block_node.children.empty?
+
           @structure[ 'database_' + block_type ].push intro_block_node.children[0].content
         }
       }

data/otrs-sopm.gemspec

@@ -16,9 +16,10 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'nokogiri', '~> 0'
+  spec.add_runtime_dependency 'nokogiri'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '~> 0'
+  spec.add_development_dependency 'bundler', '>= 1.6.9'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rubocop', '>= 0'
+  spec.add_development_dependency 'minitest', '>= 4.7.5'
 end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: otrs-sopm
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Thorsten Eckel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.6.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.6.9
 - !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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.5
 description: 
 email:
 - thorsten.eckel@znuny.com
@@ -73,8 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt