contentful-migrations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c1bda0be1633e800fda617dde80e5c119ac55a447d41a40d2657b276d63d1c4
+  data.tar.gz: 433a6db64e7e1ad24b718ef1e4609e10ee4bbf20d9e61428f8a742fad837de70
+SHA512:
+  metadata.gz: 4d22786b8b8bb1f6abab61cd4551adff371491f32881a0b3aadb133646139b18abed22ba10f7a0e53a3e24335e95c89d55a8c55b8c81fa7c45c9f474c9c6416a
+  data.tar.gz: 400571dac6d75bd1da0a1708a36de9a3f45da0e6678f3c1fa8e1e35ec483b77715793f96d2689f2128466dd4c1bb2d2df666235d7a4952db79ec0bda2d21a4c1

data/lib/contentful_migrations.rb

@@ -0,0 +1,9 @@
+require 'contentful/management'
+require 'contentful_migrations/utils'
+require 'contentful_migrations/version'
+require 'contentful_migrations/migration_content_type'
+require 'contentful_migrations/migration_proxy'
+require 'contentful_migrations/migration'
+require 'contentful_migrations/migrator'
+
+load 'tasks/contentful_migrations.rake' if defined?(Rails)

data/lib/contentful_migrations/migration.rb

@@ -0,0 +1,42 @@
+module ContentfulMigrations
+  class Migration
+    attr_reader :name, :version, :contentful_client, :contentful_space
+
+    def initialize(name = self.class.name, version = nil, client = nil, space = nil)
+      @name       = name
+      @version    = version
+      @contentful_client = client
+      @contentful_space = space
+    end
+
+    def migrate(direction, client, space)
+      @contentful_client = client
+      @contentful_space = space
+      send(direction)
+      self
+    end
+
+    def with_space
+      yield(contentful_space)
+    end
+
+    def with_editor_interfaces
+      yield(contentful_client.editor_interfaces)
+    end
+
+    def record_migration(migration_content_type)
+      entry = migration_content_type.entries.create(version: version)
+      entry.save
+      entry.publish
+      entry
+    end
+
+    def erase_migration(migration_content_type)
+      entry = migration_content_type.entries.all.find { |m| m.version.to_i == version.to_i }
+      return unless entry
+      entry.unpublish
+      entry.destroy
+      entry
+    end
+  end
+end

data/lib/contentful_migrations/migration_content_type.rb

@@ -0,0 +1,45 @@
+module ContentfulMigrations
+  class MigrationContentType
+    DEFAULT_MIGRATION_CONTENT_TYPE = 'migrations'.freeze
+
+    attr_reader :access_token, :space_id, :client, :space,
+                :migration_content_type_name, :logger
+
+    def initialize(client:,
+                   space:,
+                   logger:,
+                   migration_content_type_name: DEFAULT_MIGRATION_CONTENT_TYPE)
+      @client = client
+      @space = space
+      @logger = logger
+      @migration_content_type_name = migration_content_type_name
+    end
+
+    def resolve
+      @migration_content_type ||= find_or_create_migration_content_type
+    end
+
+  private
+
+    def find_or_create_migration_content_type
+      content_type = space.content_types.find(migration_content_type_name)
+      if content_type.nil? || content_type.is_a?(Contentful::Management::Error)
+        build_migration_content_type
+      else
+        content_type
+      end
+    end
+
+    def build_migration_content_type
+      content_type = space.content_types.create(
+        name: migration_content_type_name,
+        id: migration_content_type_name,
+        description: 'Migration Table for interal use only, do not delete'
+      )
+      content_type.fields.create(id: 'version', name: 'version', type: 'Integer')
+      content_type.save
+      content_type.publish
+      content_type
+    end
+  end
+end

data/lib/contentful_migrations/migration_proxy.rb

@@ -0,0 +1,35 @@
+require 'forwardable'
+require 'contentful_migrations/utils'
+
+module ContentfulMigrations
+  # MigrationProxy is used to defer loading of the actual migration classes
+  # until they are needed. This implementation is borrowed from activerecord's
+  # migration library.
+
+  MigrationProxy = Struct.new(:name, :version, :filename, :scope) do
+    extend Forwardable
+    include Utils
+
+    def initialize(name, version, filename, scope)
+      super
+      @migration = nil
+    end
+
+    def basename
+      File.basename(filename)
+    end
+
+    delegate %i[migrate record_migration erase_migration] => :migration
+
+    private
+
+    def migration
+      @migration ||= load_migration
+    end
+
+    def load_migration
+      require(File.expand_path(filename))
+      constantize(name).new(name, version)
+     end
+  end
+end

data/lib/contentful_migrations/migrator.rb

@@ -0,0 +1,127 @@
+module ContentfulMigrations
+  class Migrator
+    include Utils
+
+    class InvalidMigrationPath < StandardError #:nodoc:
+      def initialize(migrations_path)
+        super("#{migrations_path} is not a valid directory.")
+      end
+    end
+
+    DEFAULT_MIGRATION_PATH = 'db/contentful_migrations'.freeze
+
+    def self.migrate(args = {})
+      new(parse_options(args)).migrate
+    end
+
+    def self.rollback(args = {})
+      new(parse_options(args)).rollback
+    end
+
+    def self.pending(args = {})
+      new(parse_options(args)).pending
+    end
+
+    attr_reader :migrations_path, :access_token, :space_id, :client, :space,
+                :migration_content_type_name, :logger
+
+    def initialize(migrations_path:,
+                   access_token:,
+                   space_id:,
+                   migration_content_type_name:,
+                   logger:)
+      @migrations_path = migrations_path
+      @access_token = access_token
+      @logger = logger
+      @space_id = space_id
+      @migration_content_type_name = migration_content_type_name
+      @client = Contentful::Management::Client.new(access_token)
+      @space = @client.spaces.find(space_id)
+      validate_options
+    end
+
+    def migrate
+      runnable = migrations(migrations_path).reject { |m| ran?(m) }
+      if runnable.empty?
+        logger.info('No migrations to run, everything up to date!')
+      end
+
+      runnable.each do |migration|
+        logger.info("running migration #{migration.version} #{migration.name} ")
+        migration.migrate(:up, client, space)
+        migration.record_migration(migration_content_type)
+      end
+      self
+    end
+
+    def rollback
+      already_migrated = migrations(migrations_path).select { |m| ran?(m) }
+      migration = already_migrated.pop
+      logger.info("Rolling back migration #{migration.version} #{migration.name} ")
+      migration.migrate(:down, client, space)
+      migration.erase_migration(migration_content_type)
+    end
+
+    def pending
+      runnable = migrations(migrations_path).reject { |m| ran?(m) }
+
+      runnable.each do |migration|
+        logger.info("Pending #{migration.version} #{migration.name} ")
+      end
+    end
+
+  private
+
+    def self.parse_options(args)
+      {
+        migrations_path: ENV.fetch('MIGRATION_PATH', DEFAULT_MIGRATION_PATH),
+        access_token: ENV['CONTENTFUL_MANAGEMENT_ACCESS_TOKEN'],
+        space_id: ENV['CONTENTFUL_SPACE_ID'],
+        migration_content_type_name: MigrationContentType::DEFAULT_MIGRATION_CONTENT_TYPE,
+        logger: Logger.new(STDOUT)
+      }.merge(args)
+    end
+
+    def validate_options
+      raise InvalidMigrationPath, migrations_path unless File.directory?(migrations_path)
+    end
+
+    def ran?(migration)
+      migrated.include?(migration.version.to_i)
+    end
+
+    def migrated
+      @migrated ||= load_migrated
+    end
+
+    def load_migrated
+      migration_content_type.entries.all.map { |m| m.version.to_i }
+    end
+
+    def migrations(paths)
+      paths = Array(paths)
+      migrations = migration_files(paths).map do |file|
+        version, name, scope = parse_migration_filename(file)
+        ContentfulMigrations::MigrationProxy.new(camelize(name), version.to_i, file, scope)
+      end
+
+      migrations.sort_by(&:version)
+    end
+
+    def migration_files(paths)
+      Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
+    end
+
+    def migration_content_type
+      @migration_content_type ||= MigrationContentType.new(
+        space: space, client: client, logger: logger
+      ).resolve
+    end
+
+    MIGRATION_FILENAME_REGEX = /\A([0-9]+)_([_a-z0-9]*)\.?([_a-z0-9]*)?\.rb\z/
+
+    def parse_migration_filename(filename)
+      File.basename(filename).scan(MIGRATION_FILENAME_REGEX).first
+    end
+  end
+end

data/lib/contentful_migrations/utils.rb

@@ -0,0 +1,51 @@
+module ContentfulMigrations
+  module Utils
+    # This method was taken from ActiveSupport::Inflector to avoid having
+    # a dependency on ActiveSupport in this project.
+    # http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-constantize
+    def camelize(term, uppercase_first_letter = true)
+      string = term.to_s
+      string = if uppercase_first_letter
+        string.sub(/^[a-z\d]*/, &:capitalize)
+      else
+        string.sub(/^((?=\b|[A-Z_])|\w)/, &:downcase)
+               end
+      string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
+      string.gsub!('/'.freeze, '::'.freeze)
+      string
+    end
+    # This method was taken from ActiveSupport::Inflector to avoid having
+    # a dependency on ActiveSupport in this project.
+    # http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-constantize
+
+    def constantize(camel_cased_word)
+      names = camel_cased_word.split('::'.freeze)
+
+      # Trigger a built-in NameError exception including the ill-formed constant in the message.
+      Object.const_get(camel_cased_word) if names.empty?
+
+      # Remove the first blank element in case of '::ClassName' notation.
+      names.shift if names.size > 1 && names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        if constant == Object
+          constant.const_get(name)
+        else
+          candidate = constant.const_get(name)
+          next candidate if constant.const_defined?(name, false)
+          next candidate unless Object.const_defined?(name)
+
+          # Go down the ancestors to check if it is owned directly. The check
+          # stops when we reach Object or the end of ancestors tree.
+          constant = constant.ancestors.each_with_object(constant) do |ancestor, const|
+            break const    if ancestor == Object
+            break ancestor if ancestor.const_defined?(name, false)
+          end
+
+          # owner is in Object, so raise
+          constant.const_get(name, false)
+        end
+      end
+    end
+  end
+end

data/lib/contentful_migrations/version.rb

@@ -0,0 +1,3 @@
+module ContentfulMigrations
+  VERSION = '0.1.0'.freeze
+end

data/lib/generators/contentful_migration/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create a contentful migration
+
+Example:
+    rails generate contentful_migrations my_data
+
+    This will create:
+        db/contentful_migrations/xxxxx_my_data.rb

data/lib/generators/contentful_migration/contentful_migration_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+
+class ContentfulMigrationGenerator < Rails::Generators::NamedBase
+  # source_root File.expand_path("../templates", __FILE__)
+
+  def copy_initializer_file
+    name = file_name.to_s
+    migration_file = "db/contentful_migrations/#{next_migration_number}_#{name.underscore}.rb"
+    create_file migration_file, <<-FILE.strip_heredoc
+      class #{name.camelize} < ContentfulMigrations::Migration
+
+        def up
+          with_space do |space|
+            # TODO: use contentful-management.rb here
+          end
+        end
+
+        def down
+          with_space do |space|
+            # TODO: use contentful-management.rb here
+          end
+        end
+
+      end
+   FILE
+  end
+
+  def next_migration_number
+    Time.now.utc.strftime('%Y%m%d%H%M%S')
+  end
+end

data/lib/tasks/contentful_migrations.rake

@@ -0,0 +1,17 @@
+require 'contentful_migrations'
+namespace :contentful_migrations do
+  desc 'Migrate the contentful space, runs all pending migrations'
+  task :migrate, [:contentful_space]  do |_t, _args|
+    ContentfulMigrations::Migrator.migrate
+  end
+
+  desc 'Rollback previous contentful migration'
+  task :rollback, [:contentful_space] do |_t, _args|
+    ContentfulMigrations::Migrator.rollback
+  end
+
+  desc 'List any pending contentful migrations'
+  task :pending, [:contentful_space]  do |_t, _args|
+    ContentfulMigrations::Migrator.pending
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: contentful-migrations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin English
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contentful-management
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+description: |-
+  Migration library system for Contentful API dependent on
+                            contentful-management gem and plagarized from activerecord.
+email:
+- me@kenglish.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/contentful_migrations.rb
+- lib/contentful_migrations/migration.rb
+- lib/contentful_migrations/migration_content_type.rb
+- lib/contentful_migrations/migration_proxy.rb
+- lib/contentful_migrations/migrator.rb
+- lib/contentful_migrations/utils.rb
+- lib/contentful_migrations/version.rb
+- lib/generators/contentful_migration/USAGE
+- lib/generators/contentful_migration/contentful_migration_generator.rb
+- lib/tasks/contentful_migrations.rake
+homepage: https://github.com/monkseal/contentful-migrations.rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Contentful Migrations in Ruby
+test_files: []