gpx_kml 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed620fe7482aa20af6f157999f63fde7b05020bf8f66f73c2a3923867eda3932
-  data.tar.gz: cd97e906096ccbe17686fb22eeeee457e995b0adf8b99f5126a143286217bb1b
+  metadata.gz: c23ca7cf7f9d6dc903b41e82036593e7f9bb40b1ae5b17ecfd5faf39e2ca4bff
+  data.tar.gz: 01b06257fc564b886843e9127f3fce7a37106b49e045342aa1c318dd1c2169f0
 SHA512:
-  metadata.gz: cc4026a80235b8fb680be82b28e90c14a4abe9b38a3c9366b7f32277a6948da24d32487f8bebe5240623473ebfdabe112fecccd0da98722b4b79b0af1526d7ee
-  data.tar.gz: 00535dc2bf44c737b8f927d0d70288732117260034a7e00ae3ece46c189e6428d6e0260adff4fa0be20987ac268921567b5a9025b342b2ac6e337d8a4108aebd
+  metadata.gz: b185abea99664b9e60595dfa2782e9a712d3e3ce994e15daaa6c02dfc91ddaa478cc6e18b51b92a4aeacdd398336f2ba0ea7bfe3c8a0e4c5962939c0e83ad9c8
+  data.tar.gz: 2089d40444b18ec20b049c24a5df3f728bfaae7f4be81750f993264c818bf9920acd926a8be5c38de903c26bd3ab669a7c3db940000a30a74eca6ceebabdde3b

data/CHANGELOG.md

@@ -1,8 +1,15 @@
 ### V 0.1.x
+- v 0.1.3:
+  - changed usage & updated/fixed minor parts in documentation (README.md)
+  - added preconverted files and missing tests
+  - change in inputs for conversion functions: now they take in Gpx and Kml instances instead of file paths
+  - added new feature: now you can check whether a Gpx (or Kml) object imported an effective 'gpx' (or 'kml') file
+  - added new feature: now you can create Gpx and Kml objects from their respective files
+  - removed dependency factory_bot which ended up being unused
 - v 0.1.2:
   - fixed version tests, AGAIN
 - v 0.1.1:
-  - fixed critical bug on output file
+  - fixed critical bug on output file, path was wrong
 - v 0.1.0: 
   - fixed changelog link in rubygems.org
   - removed .idea directory in the project

data/Gemfile.lock

@@ -1,27 +1,17 @@
 PATH
   remote: .
   specs:
-    gpx_kml (0.1.2)
+    gpx_kml (0.1.3)
       nokogiri (~> 1.12.0)
       rake (~> 12.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    factory_bot (6.2.0)
-      activesupport (>= 5.0.0)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    nokogiri (1.12.5-x86_64-linux)
+    mini_portile2 (2.6.1)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
     racc (1.6.0)
     rake (12.3.3)
@@ -38,15 +28,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  factory_bot (~> 6.2)
   gpx_kml!
   rspec (~> 3.0)
 

data/README.md

@@ -1,14 +1,12 @@
 # GpxKml
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gpx_kml`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem adds the capability to convert GPS Exchange Format (GPX) files to Keyhole Markup Language (KML) files and viceversa
 
 ## Before using
 
 Please take note that this only converts essentials data for the gpx and kml files compatibility.
-However the gem doesn't just include the converter, it also transforms gpx files and kml files (only their track/route/point parts) into a Gpx/Kml file, which could be useful for a new fork or other uses.
-Just dig in deep, tests are present for everything you need, except the mere conversion.
+However the gem doesn't just include the converter, it also transforms gpx files and kml files (only their track/route/point parts) into a Gpx/Kml instance, which could be useful for new forks or other uses.
+Just dig in deep, tests are present for everything you need.
 
 ## Installation
 
@@ -28,12 +26,26 @@ Or install it yourself as:
 
 ## Usage
 
-To use it just ```require 'gpx_kml'``` in the script you need the converter and use either one of the following two functions:
-
-- ```GPXKML::GpxKml.kml_to_gpx('file_path', 'destination_path')```
-- ```GPXKML::GpxKml.gpx_to_kml('file_path', 'destination_path')```
-
-Note: destination_path must be a directory
+To use it just ```require 'gpx_kml'``` in the script you need the converter and perform the following actions:
+<br>
+Create an instance of the file you want to convert as follows:
+- ```gpx = GPXKML::GpxKml.new_gpx('file_path')``` for a gpx file
+- ```kml = GPXKML::GpxKml.new_kml('file_path')``` for a kml file
+<br><br>
+
+Now: you may want to check if the file you imported is actually a gpx or a kml.<br>
+You can do that by usign the ```gpx?``` &  ```kml?``` functions on the instance you just created:
+- ```GPXKML::GpxKml.gpx?(gpx)```
+- ```GPXKML::GpxKml.kml?(kml)```
+
+Note: this step is optional since the conversions method below do the same thing inside of themselves, but this method could turn out to be useful.
+<br><br>
+Now you can actually convert the instance to create the new file needed.<br>
+The function will return the entire path to the file just created!
+- ```path_of_the_new_file = GPXKML::GpxKml.kml_to_gpx('gpx', 'destination_path')```
+- ```path_of_the_new_file = GPXKML::GpxKml.gpx_to_kml('kml', 'destination_path')```
+
+IMPORTANT : ```destination_path``` must be a directory
 
 ## Development
 

data/gpx_kml.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['info@engim.eu']
 
   spec.summary       = 'Gem to convert .gpx into .kml and back'
-  spec.description   = 'This gem adds the capability to convert GPS Exchange Format (GPX) to Keyhole Markup Language (KML) and viceversa'
+  spec.description   = 'This gem adds the capability to convert GPS Exchange Format (GPX) files to Keyhole Markup Language (KML) files and viceversa'
   spec.homepage      = 'https://www.github.com/engim-eu/gpx_kml'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'nokogiri', '~>1.12.0'
 
   # Gem testing
-  spec.add_development_dependency 'factory_bot', '~>6.2'
   spec.add_development_dependency 'rspec', '~>3.0'
+
+  # spec.add_development_dependency 'factory_bot', '~>6.2'
+  # factory_bot isn't really used
 end

data/lib/converter.rb

@@ -3,13 +3,11 @@
 module CONVERTER
   # Docu
   class Converter
-    def self.gpx_to_kml(gpx_path, output_path)
-      return unless File.directory?(output_path)
+    def self.gpx_to_kml(gpx, output_path)
+      return unless File.directory?(output_path) && gpx.is_a?(GPX::Gpx)
+      return nil unless gpx.gpx?
 
       output_path = output_path[0..-2] if output_path[-1].eql?('/')
-      gpx = GPXKML::Gpx.new(gpx_path)
-      return nil if gpx.nil? || !gpx.valid?
-
       kml = Nokogiri::XML::Builder.new do |xml|
         xml.kml('xmlns': 'http://www.opengis.net/kml/2.2', 'xmlns:gx': 'http://www.google.com/kml/ext/2.2',
                 'xmlns:atom': 'http://www.w3.org/Atom') do
@@ -33,20 +31,22 @@ module CONVERTER
           end
         end
       end
-      name = "#{output_path}/#{Time.now.strftime('%Y%m%d%H%M%S')}_#{gpx.file_name[0..-5]}.kml"
+      name = if gpx.file_name.end_with?('.gpx') || gpx.file_name.end_with?('.xml')
+               "#{output_path}/#{Time.now.strftime('%Y%m%d%H%M%S')}_#{gpx.file_name[0..-5]}.kml"
+             else
+               "#{output_path}/#{Time.now.strftime('%Y%m%d%H%M%S')}_#{gpx.file_name}.kml"
+             end
       f = File.open(name.to_s, 'w')
       f.write(kml.to_xml)
       f.close
       name
     end
 
-    def self.kml_to_gpx(kml_path, output_path)
-      return unless File.directory?(output_path)
+    def self.kml_to_gpx(kml, output_path)
+      return nil unless File.directory?(output_path) && kml.is_a?(KML::Kml)
+      return nil unless kml.kml?
 
       output_path = output_path[0..-2] if output_path[-1].eql?('/')
-      kml = GPXKML::Kml.new(kml_path)
-      return nil if kml.nil? || !kml.valid?
-
       gpx = Nokogiri::XML::Builder.new do |xml|
         xml.gpx('version': '1.1', 'creator': 'https://www.github.com/engim-eu/gpx_kml',
                 'xmlns': 'https://www.topografix.com/GPX/1/1', 'xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance') do
@@ -58,15 +58,17 @@ module CONVERTER
           gpx_tracks(xml, kml)
         end
       end
-      name = "#{output_path}/#{Time.now.strftime('%Y%m%d%H%M%S')}_#{kml.file_name[0..-5]}.gpx"
+      name = if kml.file_name.end_with?('.kml') || kml.file_name.end_with?('.xml')
+               "#{output_path}/#{Time.now.strftime('%Y%m%d%H%M%S')}_#{kml.file_name[0..-5]}.gpx"
+             else
+               "#{output_path}/#{Time.now.strftime('%Y%m%d%H%M%S')}_#{kml.file_name}.gpx"
+             end
       f = File.open(name.to_s, 'w')
       f.write(gpx.to_xml)
       f.close
       name
     end
 
-    private
-
     def self.kml_routes(xml, gpx)
       if gpx.routes?
         gpx.routes.each do |r|

data/lib/gpx_kml/gpx.rb

@@ -33,11 +33,13 @@ module GPX
     # access in readonly to the quantity of points/routes/tracks in the gpx
     attr_reader :points_length, :routes_length, :tracks_length
 
+    def gpx?
+      !@gpx.nil? && !@gpx.xpath('/xmlns:gpx').empty?
+    end
+
     # For a gpx file to be valid it must only have a waypoint, a route or a track
     def valid?
-      return nil if @gpx.nil?
-
-      !@gpx.xpath('/xmlns:gpx').empty? && (tracks? || routes? || points?)
+      gpx? && (tracks? || routes? || points?)
     end
 
     def routes?

data/lib/gpx_kml/kml.rb

@@ -29,10 +29,12 @@ module KML
     # access data of the kml in readonly
     attr_reader :points, :routes, :tracks
 
-    def valid?
-      return nil if @kml.nil?
+    def kml?
+      !@kml.nil? && !@kml.xpath('/xmlns:kml').empty?
+    end
 
-      !@kml.xpath('/xmlns:kml').empty? && (tracks? || routes? || points?)
+    def valid?
+      kml? && (tracks? || routes? || points?)
     end
 
     def routes?

data/lib/gpx_kml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GPXKML
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/gpx_kml.rb

@@ -12,12 +12,28 @@ module GPXKML
   include CONVERTER
 
   class GpxKml
-    def self.gpx_to_kml(file_path, destination_path)
-      CONVERTER::Converter.gpx_to_kml(file_path, destination_path)
+    def self.gpx_to_kml(gpx, destination_path)
+      CONVERTER::Converter.gpx_to_kml(gpx, destination_path)
     end
 
-    def self.kml_to_gpx(file_path, destination_path)
-      CONVERTER::Converter.kml_to_gpx(file_path, destination_path)
+    def self.kml_to_gpx(kml, destination_path)
+      CONVERTER::Converter.kml_to_gpx(kml, destination_path)
+    end
+
+    def self.kml?(kml)
+      kml.is_a?(KML::Kml) && kml.kml?
+    end
+
+    def self.gpx?(gpx)
+      gpx.is_a?(GPX::Gpx) && gpx.gpx?
+    end
+
+    def self.new_kml(file_path)
+      KML::Kml.new(file_path)
+    end
+
+    def self.new_gpx(file_path)
+      GPX::Gpx.new(file_path)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gpx_kml
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Angelo Terzi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-28 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.12.0
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This gem adds the capability to convert GPS Exchange Format (GPX) to
-  Keyhole Markup Language (KML) and viceversa
+description: This gem adds the capability to convert GPS Exchange Format (GPX) files
+  to Keyhole Markup Language (KML) files and viceversa
 email:
 - info@engim.eu
 executables: []