jekyll-autoscout24 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a877e3f223382c05fc6f30e6399c77df82908e9c35ef95efde376c41d89b814f
-  data.tar.gz: d3dced66a8ebc1cd44cfb8b2f7fafe0eee055087f7a135b9634a9505c7966867
+  metadata.gz: eb5b16e86312c55df97316b4ae0b691a2a27bbce0760613cbd469709da42c8d5
+  data.tar.gz: 5325a1f86b312f5a70ffb71e0cc28679672163d765816c3fa5144160dc6d9ed6
 SHA512:
-  metadata.gz: c437ab61ef2453d4820d08980372925391c38256417b7bae67cdd0e68234c075b473307040f1de58b1b18c084a00df6d594ef53dba97315c9574332cd6738bd5
-  data.tar.gz: bf4e1481cf313b031d92fcddbf2f85ecfc7a85f195f23d469f86f2d3fd37d61e49b4bbf27fd17ff698574265ea8e7e3514030e1f860882f1004b519c1bf43f39
+  metadata.gz: 5b92adf4a76dbd64c11228a2f3bddedab083db079565fa2d782d978bc4dc42b0a7478965ff06849e6218263fbf4f171e42fafdfc360bb8f5f2f53003838af16a
+  data.tar.gz: 8dc41c6e84b54abb11c628c2f91087116b9ce9a0be51b40ea4369f4919dd187d1795416bbb1caec10e76a3eee36d6094e31792d2e9006f30bc397c0458297ecb

data/.gitignore

@@ -7,3 +7,36 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.code-workspace
+
+# Created by https://www.gitignore.io/api/osx
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+# End of https://www.gitignore.io/api/osx

data/Makefile

@@ -0,0 +1,2 @@
+run:
+	@docker-compose run jekyll /bin/bash

data/README.md

@@ -24,12 +24,17 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+The plugin jekyll-autoscout24 add to your jekyll project a folder called *autoscout24backup* in which you must put the *autoscout24backup.xml* file previously downloaded from your account AutoScout24.
+Soon continued..
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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).
 
+To validate changes end-2-end, run `bundle install` in test/test-site and then run `bundle exec theme-specs` to exercise plugin's code using Jekyll functional specifications declared in `features` folder.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-autoscout24. 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/docker-compose.yml

@@ -4,10 +4,13 @@ services:
     network_mode: bridge
     image: "jekyll/jekyll:3.6.2"
     command: "jekyll server"
+    environment:
+      - JEKYLL_ENV=production
     volumes:
-      - "$PWD:/srv/jekyll"
+      - "$PWD/test/test-site:/srv/jekyll"
+      - "$PWD:/srv/jekyll-autoscout24"
     labels:
-      - "traefik.frontend.rule=Host:pabloduo.com"
+      - "traefik.frontend.rule=Host:testme.io"
       - "traefik.enable=true"
     depends_on:
       - "reverse-proxy"

data/jekyll-autoscout24.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/autoscout24/version'
+require 'jekyll-autoscout24/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-autoscout24"
@@ -19,7 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "ox", "2.9.0"
+  spec.add_dependency "liquid", "4.0.0"
+  spec.add_dependency "jekyll", ENV["JEKYLL_VERSION"] ? "~> #{ENV["JEKYLL_VERSION"]}" : "~> 3.1"
+
+  spec.add_development_dependency "bundler", "1.16.1"
+  spec.add_development_dependency "rake", "12.3.0"
+  spec.add_development_dependency "minitest", "~> 5.11.3"
+  spec.add_development_dependency "gem-release", "1.0.0"
 end

data/lib/jekyll-autoscout24.rb

@@ -0,0 +1,6 @@
+require "ox"
+require "liquid"
+require "jekyll"
+
+require "jekyll-autoscout24/backup_reader"
+require "jekyll-autoscout24/version"

data/lib/jekyll-autoscout24/backup_reader.rb

@@ -0,0 +1,51 @@
+
+module Jekyll
+  module AutoScout24
+    class BackupReader
+      attr_reader :site, :content
+
+      # ctor
+      def initialize(site)
+        @site = site
+      end
+
+      def read!(dir)
+        # Load XML data from the backup file
+        backup = Ox.load_file("#{dir}/autoscout24.xml")
+        # Locate all vehicle nodes in the backup document
+        vehicles, nodes = [], backup.locate("stx3/vehicle_data/vehicles/vehicle")
+        # Transform each node found into an instance of Vehicle drop
+        nodes.each { |n| vehicles << Vehicle.new(n) }
+        # Merge current site data with the list of vehicles from the backup
+        @site.data.merge!("autoscout24" => vehicles) unless vehicles.empty?
+      end
+    end
+
+    # A drop in liquid is a class which allows you to export DOM like things to liquid.
+    # Methods of drops are callable.
+    # The main use for liquid drops is to implement lazy loaded objects.
+    # If you would like to make data available to the web designers which you don't want loaded unless needed then
+    # a drop is a great way to do that.
+    class Vehicle < Liquid::Drop
+      attr_reader :node
+
+      # ctor
+      def initialize(node)
+        @node = node
+      end
+
+      # Catch all method to be flexible and adaptable based on the XML structure provided.
+      def liquid_method_missing(name)
+        found = @node.locate(name)
+        return nil if found.empty?
+        found.first.text
+      end
+    end
+  end
+end
+
+# Plugin is activated after site data has been read and loaded from disk
+Jekyll::Hooks.register :site, :post_read do |site|
+  # We modify site.data collection in-place
+  Jekyll::AutoScout24::BackupReader.new(site).read!(site.config["data_dir"])
+end

data/lib/{jekyll/autoscout24 → jekyll-autoscout24}/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Autoscout24
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-autoscout24
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Enrico Caputo
@@ -9,50 +9,106 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
+        version: 3.6.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 3.6.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: A Jekyll plugin to transform AutoScout24's backup XML into a data file
 email:
 - enricocaputo.1972@gmail.com
@@ -66,14 +122,16 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - docker-compose.yml
 - jekyll-autoscout24.gemspec
-- lib/jekyll/autoscout24.rb
-- lib/jekyll/autoscout24/version.rb
+- lib/jekyll-autoscout24.rb
+- lib/jekyll-autoscout24/backup_reader.rb
+- lib/jekyll-autoscout24/version.rb
 homepage: https://github.com/staticpagesio/jekyll-autoscout24
 licenses:
 - MIT

data/lib/jekyll/autoscout24.rb

@@ -1,7 +0,0 @@
-require "jekyll/autoscout24/version"
-
-module Jekyll
-  module Autoscout24
-    # Your code goes here...
-  end
-end