geoserver_migrations 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92b8423112ac07d6f582f135ff9dddc19ad21735
+  data.tar.gz: 9de2a13435f58793d77d197dc64995032bbb5570
+SHA512:
+  metadata.gz: b3a41c386c5f07fa7472b8c3eb1d2be7c89e6872fbba86f0d6f1efc71e5bdd5a121570a0304e30be3baa1788b69d70c130066b01953de3582a5df38be0ac9868
+  data.tar.gz: d2c96d02f7eacca6fc46925c852abb6755a89050675f0df11c9fa7e98906d1c9d0bccf416b799206c0f7cc6a7892a3ae5a287b47dab7db9f2873593d661cd01d

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GeoserverMigrations'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake-version'
+RakeVersion::Tasks.new do |v|
+  v.copy 'lib/geoserver_migrations/version.rb'
+end
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/models/geoserver_migration.rb

@@ -0,0 +1,21 @@
+class GeoserverMigration < ActiveRecord::Base
+
+  self.primary_key = 'version'
+
+  def self.all_versions
+    order(:version).pluck(:version)
+  end
+
+  def self.set_migrated(migration)
+    self.create!(version: migration.version.to_s)
+  end
+
+  def self.set_reverted(migration)
+    self.where(version: migration.version.to_s).destroy_all
+  end
+
+  def version
+    super.to_i
+  end
+
+end

data/db/migrate/20180104170500_create_geoserver_migrations.rb

@@ -0,0 +1,8 @@
+class CreateGeoserverMigrations < ActiveRecord::Migration
+  def change
+    create_table :geoserver_migrations, id: false do |t|
+      t.string :version
+    end
+    add_index :geoserver_migrations, :version, unique: true  
+  end
+end

data/lib/generators/geoserver_migrations/add/add_generator.rb

@@ -0,0 +1,26 @@
+module GeoserverMigrations
+  module Generators
+    class AddGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Adds an empty named migration"
+
+      def add_migration
+        migration_name = file_name.underscore
+        class_name = file_name.camelize
+
+        create_file File.join(Rails.root, GeoserverMigrations.migrations_rootpath, "#{Time.now.strftime('%Y%m%d%H%M%S')}_#{migration_name}.rb"), <<-MIGRATION_FILE
+class #{class_name} < GeoserverMigrations::Migration
+
+  def run 
+    # add migration code here
+  end 
+
+end
+MIGRATION_FILE
+        
+      end
+
+    end
+  end
+end

data/lib/generators/geoserver_migrations/install/install_generator.rb

@@ -0,0 +1,20 @@
+module GeoserverMigrations
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      desc "This generator installs the default config file, and glue code into application-controller; which you can edit"
+
+
+      def copy_config_file
+        copy_file "geoserver_migrations_config.yml", "config/geoserver_migrations_config.yml"
+      end
+
+      def create_migrations_folder
+        # empty_directory "geoserver", "migrate"
+        empty_directory "geoserver/migrate"
+        empty_directory "geoserver/migrate/assets"
+      end
+
+    end
+  end
+end

data/lib/generators/geoserver_migrations/install/templates/geoserver_migrations_config.yml

@@ -0,0 +1,15 @@
+development: &common
+  # define migrations_path if you want to keep your migrations in a different folder
+  # migrations_path: 'geoserver/migrate'
+  geoserver_base: "http://localhost:8080/geoserver"
+  api:
+    user: admin
+    password: geoserver
+  workspace: your-workspace
+  datastore: your-datastore
+
+test:
+  <<: *common   # merges key:value pairs defined in development anchor
+
+production:
+  <<: *common   # merges key:value pairs defined in development anchor

data/lib/generators/geoserver_migrations/migrate/migrate_generator.rb

@@ -0,0 +1,15 @@
+module GeoserverMigrations
+  module Generators
+    class MigrateGenerator < ::Rails::Generators::Base
+      desc "Check and run the needed geoserver migrations"
+
+      def run_migrations
+        migrator = GeoserverMigrations::Migrator.new
+        migrator.migrations_paths = GeoserverMigrations.migrations_rootpath
+        migrator.migrations_paths = GeoserverMigrations.migrations_rootpath
+        migrator.migrate
+      end
+
+    end
+  end
+end

data/lib/generators/geoserver_migrations/redo/redo_generator.rb

@@ -0,0 +1,20 @@
+module GeoserverMigrations
+  module Generators
+    class RedoGenerator < ::Rails::Generators::Base
+      desc "Redo the last geoserver migrations"
+
+      def rollback_migrations
+        migrator = GeoserverMigrations::Migrator.new
+        migrator.migrations_paths = GeoserverMigrations.migrations_rootpath
+        # there should not be any pending migrations!
+        if migrator.needs_migration?
+          puts "There are pending migrations! We can only redo the last migration if there are no pending migrations."
+        else
+          migrator.rollback
+          migrator.migrate
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/geoserver_migrations/rollback/rollback_generator.rb

@@ -0,0 +1,14 @@
+module GeoserverMigrations
+  module Generators
+    class RollbackGenerator < ::Rails::Generators::Base
+      desc "Rollback the last geoserver migrations"
+
+      def rollback_migrations
+        migrator = GeoserverMigrations::Migrator.new
+        migrator.migrations_paths = GeoserverMigrations.migrations_rootpath
+        migrator.rollback
+      end
+
+    end
+  end
+end

data/lib/generators/geoserver_migrations/status/status_generator.rb

@@ -0,0 +1,53 @@
+module GeoserverMigrations
+  module Generators
+    class StatusGenerator < ::Rails::Generators::Base
+      desc "Verify geoserver-migrations is setup correctly"
+
+      def check_status
+        puts "Checking configuration ... "
+        errors = []
+        errors << "geoserver_base is not set" unless GeoserverMigrations.config[:geoserver_base].present?
+        errors << "api-user is not set" unless       GeoserverMigrations.config[:api][:user].present?
+        errors << "api-password is not set" unless GeoserverMigrations.config[:api][:password].present?
+
+        errors << "Geoserver workspace is not set" unless GeoserverMigrations.config[:workspace].present?
+        errors << "Geoserver datastore is not set" unless GeoserverMigrations.config[:datastore].present?
+
+        unless errors.count > 0
+          puts " --> Configuration ok"
+        else
+          puts "Problems with the configuration-file:\n #{errors.join("\n")}"
+          puts "Check the documentation how to fix them"
+          puts "Did you forget to edit the default config-file or to run rails g geoserver_migrations:install ?"
+        end
+
+        puts "Checking API reachability"
+        begin
+          layers = GeoserverMigrations::Base.connection.test
+          puts " --> Connected to API correctly and retrieved #{layers.count} layers"
+        rescue => e
+          puts "    FAILED to reach Geoserver REST API."
+          puts "    Error: #{e.message}"
+        end
+
+        puts "Checking database setup"
+        begin
+          count = GeoserverMigration.all_versions.count
+          puts " --> Database is correctly setup"
+        rescue => e
+          puts "    Database is not setup correctly. Did you run rake db:migrate ?"
+          puts "    The returned error is #{e.message}"
+        end
+
+        migrator = GeoserverMigrations::Migrator.new
+        if migrator.needs_migration?
+          puts "There are pending migrations."
+        else
+          puts "There are no pending migrations. Geoserver is up to date."
+        end
+
+      end
+
+    end
+  end
+end

data/lib/geoserver_migrations.rb

@@ -0,0 +1,89 @@
+require 'geoserver_migrations/migration_proxy'
+require 'geoserver_migrations/migration'
+require 'geoserver_migrations/migrator'
+require 'geoserver_migrations/base'
+require 'geoserver_migrations/test_connector'
+require 'geoserver_migrations/api_connector'
+require 'geoserver_migrations/layer_config'
+require 'geoserver_migrations/layergroup_config'
+
+
+module GeoserverMigrations
+
+  #define exceptions
+
+  module ExceptionsMixin
+    def initialize(str)
+      super("GeoserverMigrations: " + str)
+    end
+  end
+  class ArgumentError < ::ArgumentError #:nodoc:
+    include ExceptionsMixin
+  end
+
+  class IllegalMigrationNameError < StandardError #:nodoc:
+    include ExceptionsMixin
+    def initialize(name = nil)
+      if name
+        super("Illegal name for migration file: #{name}\n\t(only lower case letters, numbers, and '_' allowed).")
+      else
+        super("Illegal name for migration.")
+      end
+    end
+  end
+
+
+  def self.migrations_rootpath
+    (!GeoserverMigrations.config.nil? && GeoserverMigrations.config[:migrations_path]) || 'geoserver/migrate'
+  end
+
+  def self.assets_path
+    "#{self.migrations_rootpath}/assets"
+  end
+
+  def self.config
+    ::GEOSERVER_MIGRATIONS_CONFIG
+  end
+
+  # class AccessDenied < ::StandardError #:nodoc:
+  #   include ExceptionsMixin
+  #   def initialize(str='Access denied: you do not have the right permissions for the requested action.')
+  #     super(str)
+  #   end
+  # end
+
+
+  class Engine < ::Rails::Engine
+
+    # configure our plugin on boot
+    initializer "geoserver_migrations.initialize" do |app|
+
+      # mixin our code ?
+      # ActionController::Base.send(:include, Vigilante::ControllerExtension)
+      # ActiveRecord::Base.send(:include, Vigilante::ActiveRecordExtensions)
+
+      #load configuration files if they are available
+      geoserver_config_file         = File.join("#{Rails.root.to_s}", 'config', 'geoserver_migrations_config.yml')
+
+      if File.exist?(geoserver_config_file)
+        Rails.logger.debug "define GEOSERVER_MIGRATIONS_CONFIG"
+        raw_config = File.read(geoserver_config_file)
+        ::GEOSERVER_MIGRATIONS_CONFIG = YAML.load(raw_config)["#{Rails.env}"].with_indifferent_access
+      # else
+      #   raise GeoserverMigrations::ArgumentError.new("The geoserver_migrations_config.yml is missing. Path=#{geoserver_config_file} Did you run the generator geoserver_migrations:install? ")
+      end
+    end
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s == root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+
+    end
+
+  end
+
+
+end

data/lib/geoserver_migrations/api_connector.rb

@@ -0,0 +1,110 @@
+module GeoserverMigrations
+  class APIConnector
+
+    def initialize
+      # initialise geoserver-client
+      GeoserverClient.api_root = ::GEOSERVER_MIGRATIONS_CONFIG[:geoserver_base]
+      GeoserverClient.api_user = ::GEOSERVER_MIGRATIONS_CONFIG[:api][:user]
+      GeoserverClient.api_password = ::GEOSERVER_MIGRATIONS_CONFIG[:api][:password]
+
+      GeoserverClient.workspace    = GEOSERVER_MIGRATIONS_CONFIG[:workspace]
+      GeoserverClient.datastore    = GEOSERVER_MIGRATIONS_CONFIG[:datastore]
+      # if Rails.present?
+      #   GeoserverClient.logger = Rails.logger
+      # end
+      GeoserverClient.logger = :stdout 
+    end
+
+    def execute(ordered_actions, direction = :up, options={})
+      if direction != :up
+        ordered_actions = ordered_actions.reverse
+      end
+
+      ordered_actions.each do |action_to_complete|
+        case action_to_complete[:action]
+          when :add_resource
+            file_name = action_to_complete[:params][:name]
+            if direction == :up
+              GeoserverClient.create_resource file_name
+            else
+              GeoserverClient.delete_resource file_name
+            end
+          when :create_layer
+            layer_name = action_to_complete[:params][:name]
+            layer_config = action_to_complete[:params][:layer_config]
+            if direction == :up
+              # explicitly create style if sld given
+              if !layer_config.sld.nil?
+                puts " -- Create style #{layer_config.style_name}"
+
+                GeoserverClient.create_style layer_config.style_name, sld: layer_config.sld
+              end
+
+              puts " -- Create layer #{layer_config.layer_name} [native_name = #{layer_config.feature_name}]"
+              GeoserverClient.create_featuretype layer_name, native_name: layer_config.feature_name
+              GeoserverClient.set_layer_style layer_name, layer_config.style_name
+            else
+              puts " -- delete layer #{layer_config.layer_name}"
+              GeoserverClient.delete_featuretype layer_name
+
+              if !layer_config.sld.nil?
+                puts " -- delete style #{layer_config.style_name}"
+
+                GeoserverClient.delete_style layer_config.style_name
+              end
+
+            end
+          when :delete_layer
+            if direction == :up
+              layer_name = action_to_complete[:params][:name]
+              puts " -- Delete layer #{layer_name}"
+              GeoserverClient.delete_featuretype layer_name
+            else
+              # do nothing??
+              # we should save the layer-definition in the :up direction so we can
+              # restore it if needed?
+            end
+          when :delete_style
+            if direction == :up
+              style_name = action_to_complete[:params][:name]
+              puts " -- Delete style #{style_name}"
+              GeoserverClient.delete_style style_name
+            end
+          when :update_style
+            if direction == :up
+              style_name = action_to_complete[:params][:name]
+              layer_config = action_to_complete[:params][:layer_config]
+              puts " -- Updating style #{style_name}"
+              GeoserverClient.update_style style_name, sld: layer_config.sld
+            end
+          when :create_layergroup
+            layer_name = action_to_complete[:params][:name]
+            layer_config = action_to_complete[:params][:layer_config]
+            if direction == :up
+              GeoserverClient.create_layergroup layer_name, layer_config.layers
+            else
+              puts " -- delete layergroup #{layer_config.layer_name}"
+              GeoserverClient.delete_layergroup layer_name
+            end
+          when :delete_layergroup
+            if direction == :up
+              layer_name = action_to_complete[:params][:name]
+              puts " -- Delete layergroup #{layer_name}"
+              GeoserverClient.delete_layergroup layer_name
+            else
+              # do nothing??
+              # we should save the layer-definition in the :up direction so we can
+              # restore it if needed?
+            end
+
+         end
+      end
+    end
+
+    def test
+      layers = GeoserverClient.layers
+      layers["featureTypes"]["featureType"].map{|l| l["name"]}
+    end
+
+  end
+end

data/lib/geoserver_migrations/base.rb

@@ -0,0 +1,13 @@
+module GeoserverMigrations
+  module Base
+
+    def self.connection=(connector)
+      @connection = connector
+    end
+
+    def self.connection
+      @connection ||= GeoserverMigrations::APIConnector.new
+    end
+
+  end
+end

data/lib/geoserver_migrations/layer_config.rb

@@ -0,0 +1,47 @@
+require 'geoserver_migrations/sld_helpers'
+
+module GeoserverMigrations
+  class LayerConfig
+
+    # attr_writer :sld, :layer_name, :feature_name, :style_name
+    attr_accessor :options
+
+    def initialize(layer_name, is_update_style=false)
+      @options = {
+          layer_name: layer_name,
+          is_update_style: is_update_style
+      }
+
+    end
+
+    include GeoserverMigrations::SldHelpers 
+    
+    def valid?
+      # at least feature-name should be present?
+      options[:feature_name].present? || (options[:is_update_style] && options[:sld].present?)
+    end
+
+    def style_name(style_name=nil)
+      if style_name.nil?
+        @options[:style_name] || @options[:layer_name]
+      else
+        @options[:style_name] = style_name
+      end   
+    end
+
+    def method_missing(method,*args,&block)
+      # puts "LayerConfig method-missing: #{method.inspect}, #{args.inspect}"
+      if [:sld, :layer_name, :feature_name, :style_name].include? method.to_sym
+        if args.size > 0
+          value = args.size == 1 ? args.first : args
+          value = value.strip if value.is_a? String 
+          @options[method.to_sym] = value
+        else 
+          @options[method.to_sym]
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/geoserver_migrations/layergroup_config.rb

@@ -0,0 +1,48 @@
+module GeoserverMigrations
+  class LayergroupConfig
+
+    attr_accessor :options
+
+    def initialize(layer_name, is_update_style=false)
+      @options = {
+          layer_name: layer_name,
+          is_update_style: is_update_style,
+          layers: []
+      }
+    end
+
+    def valid?
+      # at least one layer to be grouped should be present?
+      options[:layers].size > 0
+    end
+
+    def layers(*received_layers)
+      if received_layers.nil?
+        @options[:layers]
+      else
+        if received_layers.is_a? String
+          @options[:layers] = received_layers.split(/[,; ]/).select{|x| !x.empty?}
+        elsif received_layers.is_a? Array
+          received_layers.each do |received_layer|
+            @options[:layers] += received_layer.split(/[,; ]/).select{|x| !x.empty?}
+          end   
+        end           
+      end
+    end
+
+    def method_missing(method,*args,&block)
+      # puts "LayerConfig method-missing: #{method.inspect}, #{args.inspect}"
+      if [:layer_name].include? method.to_sym
+        if args.size > 0
+          value = args.size == 1 ? args.first : args
+          value = value.strip if value.is_a? String
+          @options[method.to_sym] = value
+        else
+          @options[method.to_sym]
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/geoserver_migrations/migration.rb

@@ -0,0 +1,116 @@
+module GeoserverMigrations
+  class Migration
+
+    attr_accessor :name, :version, :assets_path
+
+    def initialize(name = self.class.name, version = nil)
+      @name       = name
+      @version    = version
+      @connection = nil
+      @layers_to_create = {}
+      @layers_to_delete = []
+      @styles_to_delete = []
+      @ordered_actions_to_take = []
+      @assets_path = nil
+    end
+
+    def migrate(direction = :up)
+      return unless [:up, :down].include?(direction)
+
+      case direction
+        when :up   then announce "migrating"
+        when :down then announce "reverting"
+      end
+
+      time = Benchmark.measure do
+        # collect configuration
+        run
+
+        # puts @layers_to_create.inspect
+
+        # create configured layers
+        GeoserverMigrations::Base.connection.execute(@ordered_actions_to_take, direction)
+      end
+
+      operation = direction == :up ? 'migrated' : 'reverted'
+      announce "#{operation} (%.4fs)" % time.real; write
+    end
+
+
+    def add_resource(resource_name)
+      # translate to full file-name and raise error if not exists?
+
+      full_resource_name = File.join(File.expand_path(self.assets_path), resource_name )
+
+      raise StandardError.new("File #{full_resource_name} not found!") unless File.exists?(full_resource_name)
+
+      @ordered_actions_to_take << {action: :add_resource, params: {name: full_resource_name }}
+    end
+
+    def create_layer(layer_name, &block)
+      layer_config = GeoserverMigrations::LayerConfig.new(layer_name)
+      layer_config.instance_eval(&block) if block_given?
+      if layer_config.valid?
+        @layers_to_create[layer_name] = layer_config
+        @ordered_actions_to_take << {action: :create_layer, params: {name: layer_name, layer_config: layer_config}}
+      end
+    end
+
+    def create_layergroup(layer_name, &block)
+      layergroup_config = GeoserverMigrations::LayergroupConfig.new(layer_name)
+      layergroup_config.instance_eval(&block) if block_given?
+      if layergroup_config.valid?
+        @layers_to_create[layer_name] = layergroup_config
+        @ordered_actions_to_take << {action: :create_layergroup, params: {name: layer_name, layer_config: layergroup_config}}
+      end
+    end
+
+    def update_style(layer_name, &block)
+      layer_config = GeoserverMigrations::LayerConfig.new(layer_name, true)
+      layer_config.instance_eval(&block) if block_given?
+      if layer_config.valid?
+        @ordered_actions_to_take << {action: :update_style, params: {name: layer_name, layer_config: layer_config}}
+      end
+    end
+
+    def delete_layer(layer_name)
+      @layers_to_delete << layer_name
+      @ordered_actions_to_take << {action: :delete_layer, params: {name: layer_name }}
+    end
+
+    def delete_layergroup(layer_name)
+      @layers_to_delete << layer_name
+      @ordered_actions_to_take << {action: :delete_layergroup, params: {name: layer_name }}
+    end
+
+    def delete_style(style_name)
+      @styles_to_delete << style_name
+      @ordered_actions_to_take << {action: :delete_style, params: {name: style_name }}
+    end
+
+    def write(text = "")
+      puts(text) unless Rails.env.test? 
+    end
+
+    def announce(message)
+      text = "#{version} #{name}: #{message}"
+      length = [0, 75 - text.length].max
+      write "== %s %s" % [text, "=" * length]
+    end
+
+    def say(message, subitem = false)
+      write "#{subitem ? "   ->" : "--"} #{message}"
+    end
+
+    def say_with_time(message)
+      say(message)
+      result = nil
+      time = Benchmark.measure { result = yield }
+      say "%.4fs" % time.real, :subitem
+      say("#{result} rows", :subitem) if result.is_a?(Integer)
+      result
+    end
+
+
+  end
+end

data/lib/geoserver_migrations/migration_proxy.rb

@@ -0,0 +1,34 @@
+module GeoserverMigrations
+
+  # MigrationProxy is used to defer loading of the actual migration classes
+  # until they are needed
+  MigrationProxy = Struct.new(:name, :version, :filename, :scope) do
+    def initialize(name, version, filename, scope)
+      super
+      @migration = nil
+    end
+
+    def basename
+      File.basename(filename)
+    end
+
+    def mtime
+      File.mtime filename
+    end
+
+    delegate :migrate, to: :migration
+    delegate :assets_path=, to: :migration
+
+    private
+
+    def migration
+      @migration ||= load_migration
+    end
+
+    def load_migration
+      require(File.expand_path(filename))
+      name.constantize.new(name, version)
+    end
+  end
+
+end

data/lib/geoserver_migrations/migrator.rb

@@ -0,0 +1,109 @@
+module GeoserverMigrations
+
+  class Migrator
+
+    MigrationFilenameRegexp = /\A([0-9]+)_([_a-z0-9]*)\.?([_a-z0-9]*)?\.rb\z/
+
+    def migrate
+      if !any_migrations?
+        puts "No migration files found!"
+      else
+        if !needs_migration?
+          puts "There are no pending migrations."
+        else
+          pending_migrations.each do |migration|
+            migration.assets_path = GeoserverMigrations.assets_path
+            migration.migrate
+            
+            GeoserverMigration.set_migrated(migration)
+          end
+        end
+      end
+    end
+
+
+    def rollback(steps=1)
+      if steps < 1
+        puts "The nr of steps to rollback has to be at least 1"
+      else
+        rollback_migrations(steps).each do |migration|
+          migration.assets_path = GeoserverMigrations.assets_path
+          migration.migrate(:down)
+
+          GeoserverMigration.set_reverted(migration)
+        end
+      end
+    end
+
+
+
+    def get_all_versions
+      begin
+        GeoserverMigration.all_versions.map(&:to_i)
+      rescue
+        []
+      end
+    end
+
+    def current_version
+      get_all_versions.max || 0
+    end
+
+    def needs_migration?
+      (migrations(migrations_paths).collect(&:version) - get_all_versions).size > 0
+    end
+
+    def any_migrations?
+      migrations(migrations_paths).any?
+    end
+
+
+    def rollback_migrations(steps=1)
+      to_rollback = get_all_versions[0 - steps .. -1]
+      migrations = migrations(migrations_paths)
+      migrations.select { |m| to_rollback.include?(m.version) }
+    end
+
+    def pending_migrations
+      already_migrated = get_all_versions
+      migrations = migrations(migrations_paths)
+      migrations.reject { |m| already_migrated.include?(m.version) }
+    end
+
+
+    def migrations_paths=(paths)
+      @migrations_paths = paths
+    end
+
+    def migrations_paths
+      @migrations_paths ||= ["geoserver/migrate"]
+      # just to not break things if someone uses: migrations_path = some_string
+      Array(@migrations_paths)
+    end
+
+    def parse_migration_filename(filename) # :nodoc:
+      File.basename(filename).scan(MigrationFilenameRegexp).first
+    end
+
+    def migrations(paths)
+      paths = Array(paths)
+
+      migrations = migration_files(paths).map do |file|
+        version, name, scope = parse_migration_filename(file)
+        raise GeoserverMigrations::IllegalMigrationNameError.new(file) unless version
+        version = version.to_i
+        name = name.camelize
+
+        MigrationProxy.new(name, version, file, scope)
+      end
+
+      migrations.sort_by(&:version)
+    end
+
+    def migration_files(paths)
+      Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
+    end
+
+
+  end
+end

data/lib/geoserver_migrations/sld_helpers.rb

@@ -0,0 +1,338 @@
+module GeoserverMigrations
+  module SldHelpers
+
+
+    def build_sld_filter(filter_hash)
+      filter_text = ""
+      filters_count = filter_hash.keys.count
+      if filters_count > 0
+        if filters_count == 1
+          filter_text = <<-FILTER
+            <ogc:Filter>
+              <ogc:PropertyIsEqualTo>
+                <ogc:PropertyName>#{filter_hash.keys[0]}</ogc:PropertyName>
+                <ogc:Literal>#{filter_hash.values[0]}</ogc:Literal>
+              </ogc:PropertyIsEqualTo>
+            </ogc:Filter>
+          FILTER
+        elsif filters_count == 2
+          filter_text = <<-FILTER
+            <ogc:Filter>
+              <ogc:And>
+                <ogc:PropertyIsEqualTo>
+                  <ogc:PropertyName>#{filter_hash.keys[0]}</ogc:PropertyName>
+                  <ogc:Literal>#{filter_hash.values[0]}</ogc:Literal>
+                </ogc:PropertyIsEqualTo>
+                <ogc:PropertyIsEqualTo>
+                  <ogc:PropertyName>#{filter_hash.keys[1]}</ogc:PropertyName>
+                  <ogc:Literal>#{filter_hash.values[1]}</ogc:Literal>
+                </ogc:PropertyIsEqualTo>
+              </ogc:And>  
+            </ogc:Filter>
+          FILTER
+        else
+          raise StandardError.new("Unsupported filter! For now we only support 1 or 2 filter-values :( :(")
+        end
+      end
+      filter_text
+    end
+
+
+    def icon_style_with_label(title, icon_name, icon_style_options={})
+      display_label = icon_style_options[:display_label] || title
+      abstract      = icon_style_options[:abstract] || title
+
+      filter_text = ""
+      if icon_style_options[:filter].present? && icon_style_options[:filter].is_a?(Hash)
+        filter_text = build_sld_filter(icon_style_options[:filter])
+      end
+
+      max_scale_text = ""
+      if icon_style_options[:max_scale_denominator].present?
+        max_scale_text = "<MaxScaleDenominator>#{icon_style_options[:max_scale_denominator]}</MaxScaleDenominator>"
+      end
+
+      @options[:sld] = <<-SLD.strip_heredoc 
+        <?xml version="1.0" encoding="UTF-8"?>
+        <StyledLayerDescriptor version="1.0.0" xmlns="http://www.opengis.net/sld" xmlns:ogc="http://www.opengis.net/ogc"
+          xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://www.opengis.net/sld http://schemas.opengis.net/sld/1.0.0/StyledLayerDescriptor.xsd">
+          <NamedLayer>
+            <Name>#{title}</Name>
+            <UserStyle>
+              <Name>#{title}</Name>
+              <Title>#{title}</Title>
+              <Abstract>#{abstract}</Abstract>
+              <FeatureTypeStyle>
+                <Rule>
+                  <Title>#{display_label}</Title>  
+                  #{filter_text}
+                  #{max_scale_text}  
+                  <PointSymbolizer>
+                    <Graphic>
+                      <ExternalGraphic>
+                        <OnlineResource xlink:type="simple" xlink:href="#{icon_name}" />
+                        <Format>image/png</Format>
+                      </ExternalGraphic>
+                    </Graphic>
+                    <VendorOption name="labelObstacle">true</VendorOption>
+                  </PointSymbolizer>
+                  <TextSymbolizer>
+                    <Label>
+                      <ogc:PropertyName>name</ogc:PropertyName>
+                    </Label>
+                    <Font>
+                      <CssParameter name="font-family">Arial</CssParameter>
+                      <CssParameter name="font-size">11</CssParameter>
+                      <CssParameter name="font-style">normal</CssParameter>
+                      <CssParameter name="font-weight">bold</CssParameter>
+                    </Font>
+                    <LabelPlacement>
+                      <PointPlacement>
+                        <AnchorPoint>
+                          <AnchorPointX>0</AnchorPointX>
+                          <AnchorPointY>0</AnchorPointY>
+                        </AnchorPoint>
+                      </PointPlacement>
+                    </LabelPlacement>
+                    <Halo>
+                      <Radius>
+                        <ogc:Literal>1</ogc:Literal>
+                      </Radius>
+                      <Fill>
+                        <CssParameter name="fill">#ffffff</CssParameter>
+                      </Fill>
+                    </Halo>
+                    <Fill>
+                      <CssParameter name="fill">#2f3133</CssParameter>
+                    </Fill>
+                    <VendorOption name="maxDisplacement">40</VendorOption>
+                    <!--VendorOption name="displacementMode">S, SW, W, NW, N</VendorOption-->
+                    <VendorOption name="conflictResolution">true</VendorOption>   
+                    <VendorOption name="partials">true</VendorOption>
+                  </TextSymbolizer>          
+                </Rule>
+              </FeatureTypeStyle>
+            </UserStyle>
+          </NamedLayer>
+        </StyledLayerDescriptor>
+      SLD
+
+    end
+
+
+    def polygon_style(title, style_options={})
+      display_label = style_options[:display_label] || title
+      abstract      = style_options[:abstract] || title
+
+      fill_colour   = style_options[:fill_colour]   || "#aaaaaa"
+      fill_opacity  = style_options[:fill_opacity]  || "1"
+      stroke_colour = style_options[:stroke_colour] || "#000000"
+      stroke_width  = style_options[:stroke_width]  || "1"
+
+      filter_text = ""
+      if style_options[:filter].present? && style_options[:filter].is_a?(Hash)
+        filter_text = build_sld_filter(style_options[:filter])
+      end
+
+      fill_style = ""
+      unless style_options[:no_fill] == true
+        fill_styles = ["<Fill>"]
+        fill_styles << "                      <CssParameter name=\"fill\">#{fill_colour}</CssParameter>"
+        fill_styles << "                      <CssParameter name=\"opacity\">#{fill_opacity}</CssParameter>" if style_options[:fill_opacity].present?
+        fill_styles << "                    </Fill>"
+        fill_style = fill_styles.join("\n")
+      end
+
+
+      stroke_styles = []
+      stroke_styles << "<Stroke>"
+      stroke_styles << "                      <CssParameter name=\"stroke\">#{stroke_colour}</CssParameter>"
+      stroke_styles << "                      <CssParameter name=\"stroke-width\">#{stroke_width}</CssParameter>"
+
+      if style_options[:stroke_dasharray].present?
+        stroke_styles << "                      <CssParameter name=\"stroke-dasharray\">"
+        stroke_styles << "                           <ogc:Literal>#{style_options[:stroke_dasharray]}</ogc:Literal>"
+        stroke_styles << "                      </CssParameter>"
+      end
+      stroke_styles << "                    </Stroke>"
+      stroke_style = stroke_styles.join("\n")
+
+      max_scale_text = ""
+      if style_options[:max_scale_denominator].present?
+        max_scale_text = "<MaxScaleDenominator>#{style_options[:max_scale_denominator]}</MaxScaleDenominator>"
+      end
+
+      @options[:sld] = <<-SLD.strip_heredoc
+        <?xml version="1.0" encoding="UTF-8"?>
+        <StyledLayerDescriptor version="1.0.0" 
+         xsi:schemaLocation="http://www.opengis.net/sld StyledLayerDescriptor.xsd" 
+         xmlns="http://www.opengis.net/sld" 
+         xmlns:ogc="http://www.opengis.net/ogc" 
+         xmlns:xlink="http://www.w3.org/1999/xlink" 
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+          <NamedLayer>
+            <Name>#{title}</Name>
+            <UserStyle>
+              <Name>#{title}</Name>
+              <Title>#{title}</Title>
+              <Abstract>#{abstract}</Abstract>
+              <FeatureTypeStyle>
+                <Rule>
+                  <Title>#{display_label}</Title>  
+                  #{filter_text}
+                  #{max_scale_text}  
+                  <PolygonSymbolizer>   
+                    #{fill_style}
+                    #{stroke_style}
+                  </PolygonSymbolizer>
+                </Rule>
+              </FeatureTypeStyle>
+            </UserStyle>
+          </NamedLayer>
+        </StyledLayerDescriptor>
+      SLD
+
+    end
+
+
+    def line_style(title, style_options={})
+      display_label = style_options[:display_label] || title
+      abstract      = style_options[:abstract] || title
+
+      stroke_colour = style_options[:stroke_colour] || "#000000"
+      stroke_width  = style_options[:stroke_width]  || "1"
+
+
+      filter_text = ""
+      if style_options[:filter].present? && style_options[:filter].is_a?(Hash)
+        filter_text = build_sld_filter(style_options[:filter])
+      end
+
+      max_scale_text = ""
+      if style_options[:max_scale_denominator].present?
+        max_scale_text = "<MaxScaleDenominator>#{style_options[:max_scale_denominator]}</MaxScaleDenominator>"
+      end
+
+      @options[:sld] = <<-SLD.strip_heredoc
+        <?xml version="1.0" encoding="UTF-8"?>
+        <StyledLayerDescriptor version="1.0.0" 
+         xsi:schemaLocation="http://www.opengis.net/sld StyledLayerDescriptor.xsd" 
+         xmlns="http://www.opengis.net/sld" 
+         xmlns:ogc="http://www.opengis.net/ogc" 
+         xmlns:xlink="http://www.w3.org/1999/xlink" 
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+          <NamedLayer>
+            <Name>#{title}</Name>
+            <UserStyle>
+              <Name>#{title}</Name>
+              <Title>#{title}</Title>
+              <Abstract>#{abstract}</Abstract>
+              <FeatureTypeStyle>
+                <Rule>
+                  <Title>#{display_label}</Title>  
+                  #{filter_text}
+                  #{max_scale_text}  
+                  <LineSymbolizer>
+                    <Stroke>
+                      <CssParameter name="stroke">#{stroke_colour}</CssParameter>
+                      <CssParameter name="stroke-width">#{stroke_width}</CssParameter>
+                   </Stroke>
+                  </LineSymbolizer>
+                </Rule>
+              </FeatureTypeStyle>
+            </UserStyle>
+          </NamedLayer>
+        </StyledLayerDescriptor>
+      SLD
+
+    end
+
+    # def polygon_style_with_label(title, style_options={})
+    #   display_label = icon_style_options[:display_label] || title
+    #   abstract      = icon_style_options[:abstract] || title
+    #
+    #
+    #
+    #
+    #   @options[:sld] = <<-SLD
+    #     <?xml version="1.0" encoding="ISO-8859-1"?>
+    #     <StyledLayerDescriptor version="1.0.0"
+    #      xsi:schemaLocation="http://www.opengis.net/sld StyledLayerDescriptor.xsd"
+    #      xmlns="http://www.opengis.net/sld"
+    #      xmlns:ogc="http://www.opengis.net/ogc"
+    #      xmlns:xlink="http://www.w3.org/1999/xlink"
+    #      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    #       <NamedLayer>
+    #         <Name>#{title}</Name>
+    #         <UserStyle>
+    #           <Title>#{title}</Title>
+    #           <Abstract>#{abstract}</Abstract>
+    #           <FeatureTypeStyle>
+    #             <Rule>
+    #               <Title>#{display_label}</Title>
+    #               <MinScaleDenominator>10000</MinScaleDenominator>
+    #               <MaxScaleDenominator>200000</MaxScaleDenominator>
+    #               <PolygonSymbolizer>
+    #                 <Fill>
+    #                   <CssParameter name="fill">#AAAAAA</CssParameter>
+    #                   <CssParameter name="fill-opacity">0.3</CssParameter>
+    #                 </Fill>
+    #                 <Stroke>
+    #                   <CssParameter name="stroke">#FFFFFF</CssParameter>
+    #                   <CssParameter name="stroke-width">3</CssParameter>
+    #                 </Stroke>
+    #               </PolygonSymbolizer>
+    #             </Rule>
+    #             <Rule>
+    #               <Name>rule2</Name>
+    #               <Title>Beheerkaart ingezoomed</Title>
+    #               <Abstract>A polygon with a gray fill and a 3 pixel while outline and a label indicating the name</Abstract>
+    #               <MaxScaleDenominator>10000</MaxScaleDenominator>
+    #               <PolygonSymbolizer>
+    #                 <Fill>
+    #                   <CssParameter name="fill">#AAAAAA</CssParameter>
+    #                   <CssParameter name="fill-opacity">0.3</CssParameter>
+    #                 </Fill>
+    #                 <Stroke>
+    #                   <CssParameter name="stroke">#FFFFFF</CssParameter>
+    #                   <CssParameter name="stroke-width">3</CssParameter>
+    #                 </Stroke>
+    #               </PolygonSymbolizer>
+    #               <TextSymbolizer>
+    #                 <Geometry>
+    #                   <ogc:Function name="centroid">
+    #                     <ogc:PropertyName>geom</ogc:PropertyName>
+    #                   </ogc:Function>
+    #                 </Geometry>
+    #                 <Label>
+    #                   <ogc:PropertyName>name</ogc:PropertyName>
+    #                 </Label>
+    #                 <Font>
+    #                   <CssParameter name="font-family">Arial</CssParameter>
+    #                   <CssParameter name="font-size">18</CssParameter>
+    #                   <CssParameter name="font-style">normal</CssParameter>
+    #                   <CssParameter name="font-weight">bold</CssParameter>
+    #                 </Font>
+    #                 <Halo>
+    #                   <Radius>2</Radius>
+    #                   <Fill>
+    #                     <CssParameter name="fill">#FFFFFF</CssParameter>
+    #                   </Fill>
+    #                 </Halo>
+    #                 <Fill>
+    #                   <CssParameter name="fill">#000</CssParameter>
+    #                 </Fill>
+    #               </TextSymbolizer>
+    #             </Rule>
+    #           </FeatureTypeStyle>
+    #         </UserStyle>
+    #       </NamedLayer>
+    #     </StyledLayerDescriptor>
+    #
+    #   SLD
+    #
+    # end
+
+  end
+end

data/lib/geoserver_migrations/test_connector.rb

@@ -0,0 +1,15 @@
+module GeoserverMigrations
+  class TestConnector
+
+    attr_accessor :collected_actions
+
+    def initialize
+      @collected_actions = {}
+    end
+
+    def execute(layer_configs, direction=:up, options={})
+      collected_actions.merge!(direction => layer_configs)
+    end
+
+  end
+end

data/lib/geoserver_migrations/version.rb

@@ -0,0 +1,3 @@
+module GeoserverMigrations
+  VERSION = "0.0.2"
+end

data/lib/tasks/geoserver_migrations_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :geoserver_migrations do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: geoserver_migrations
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- "'nathanvda'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: 'Manage your geoserver configuration like you manage your database: with
+  migrations'
+email:
+- "'nathan@dixis.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/models/geoserver_migration.rb
+- db/migrate/20180104170500_create_geoserver_migrations.rb
+- lib/generators/geoserver_migrations/add/add_generator.rb
+- lib/generators/geoserver_migrations/add/templates/migration_template.rb
+- lib/generators/geoserver_migrations/install/install_generator.rb
+- lib/generators/geoserver_migrations/install/templates/geoserver_migrations_config.yml
+- lib/generators/geoserver_migrations/migrate/migrate_generator.rb
+- lib/generators/geoserver_migrations/redo/redo_generator.rb
+- lib/generators/geoserver_migrations/rollback/rollback_generator.rb
+- lib/generators/geoserver_migrations/status/status_generator.rb
+- lib/geoserver_migrations.rb
+- lib/geoserver_migrations/api_connector.rb
+- lib/geoserver_migrations/base.rb
+- lib/geoserver_migrations/layer_config.rb
+- lib/geoserver_migrations/layergroup_config.rb
+- lib/geoserver_migrations/migration.rb
+- lib/geoserver_migrations/migration_proxy.rb
+- lib/geoserver_migrations/migrator.rb
+- lib/geoserver_migrations/sld_helpers.rb
+- lib/geoserver_migrations/test_connector.rb
+- lib/geoserver_migrations/version.rb
+- lib/tasks/geoserver_migrations_tasks.rake
+homepage: https://github.com/nathanvda/geoserver_migrations
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: manage your geoserver configuration using migrations
+test_files: []