arma_fixer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a09ab5b4665de2f3e31bb39cc5767ded2c79ce76
+  data.tar.gz: 1926b5464ae286f739ac5f6d9920e5ffb74f9661
+SHA512:
+  metadata.gz: 40afc47969507acef1ef8a5444f8d2408cd11584501981ba9f7b286d8b17e666466e1042f86317ede86a377576154c8bd1691252a8c8337670b9fb61a0fd84a4
+  data.tar.gz: 9df60ad0aba67b5d7cb24fb2b7c52384f677ee9da12d4d146b2e60594bf54cc2a12dacdb882cff78190ec82d1edc691dbf14653e27427e5b645d3b5dc7f69035

data/lib/arma_fixer.rb

@@ -0,0 +1,21 @@
+require_relative './arma_fixer/version'
+require_relative './arma_fixer/validation'
+require_relative './arma_fixer/execute'
+require_relative './arma_fixer/railtie' if defined?(Rails)
+
+module ArmaFixer
+  mattr_accessor :root_path
+
+  module_function
+
+  def run!
+    start_time = Time.now
+    puts 'Started ArmaFixer task...'
+
+    ArmaFixer::Validation.run!
+    ArmaFixer::Execute.run!
+
+    time_taken = (Time.now - start_time).round(2)
+    puts "Completed ArmaFixer task in #{time_taken} seconds."
+  end
+end

data/lib/arma_fixer/execute.rb

@@ -0,0 +1,48 @@
+module ArmaFixer
+  module Execute
+    module_function
+
+    def run!
+      ArmaFixer::MODELS_HASH.each do |model_name, columns|
+        model = ArmaFixer::APP.const_get(model_name)
+
+        model.where('').each do |record|
+          save_record = false
+          columns.each do |attr, image_path|
+            value = record.public_send(attr)
+            next if checker.call(value)
+
+            save_record = true
+            method = "#{attr}="
+            image = image_path ? File.open(image_path) : default_image
+
+            value = record.public_send(method, image)
+          end
+
+          if save_record
+            record.save
+            puts "Saved #{model_name} ID #{record.id}"
+          end
+        end
+      end
+    end
+
+    private
+
+    module_function
+
+    def default_image
+      @default_image ||= File.open(ArmaFixer::DEFAULT_IMAGE_PATH) if defined?(ArmaFixer::DEFAULT_IMAGE_PATH)
+    end
+
+    def checker
+      @checker ||= begin
+        if defined?(ArmaFixer::ATTR_CHECKER)
+          ArmaFixer::ATTR_CHECKER
+        else
+          -> (v) { !v.nil? }
+        end
+      end
+    end
+  end
+end

data/lib/arma_fixer/railtie.rb

@@ -0,0 +1,12 @@
+require 'arma_fixer'
+require 'rails'
+
+module ArmaFixer
+  class Railtie < Rails::Railtie
+    railtie_name :arma_fixer
+
+    rake_tasks do
+      load File.expand_path('../tasks/run.rake', __FILE__)
+    end
+  end
+end

data/lib/arma_fixer/tasks/run.rake

@@ -0,0 +1,6 @@
+desc 'Repair missing attachments in ActiveRecord models'
+namespace :armaf do
+  task run: :environment do
+    ArmaFixer.run!
+  end
+end

data/lib/arma_fixer/validation.rb

@@ -0,0 +1,76 @@
+require 'active_record'
+
+module ArmaFixer
+  module Validation
+    module_function
+
+    def run!
+      validate_models_hash!
+      validate_default_image_path!
+      validate_attribute_checker!
+    end
+
+    private
+
+    module_function
+
+    def validate_models_hash!
+      validate_models_hash_presence!
+      validate_models_hash_contents!
+    end
+
+    def validate_models_hash_presence!
+      return if defined?(ArmaFixer::MODELS_HASH) &&
+                ArmaFixer::MODELS_HASH &&
+                !ArmaFixer::MODELS_HASH.empty?
+
+      fail 'ArmaFixer::MODELS_HASH cannot be undefined or empty.'
+    end
+
+    def validate_models_hash_contents!
+      ArmaFixer::MODELS_HASH.each_value do |attributes|
+        case attributes
+        when Array
+          if attributes.empty?
+            fail 'attributes array cannot be empty'
+          elsif !default_image_path_defined?
+            fail 'ArmaFixer::DEFAULT_IMAGE_PATH must exist in case of array attributes'
+          end
+        when Hash
+          if attributes.empty?
+            fail 'attributes hash cannot be empty'
+          else
+            attributes.each_value do |path|
+              fail "file not found at #{path}" unless File.exist?(path)
+            end
+          end
+        else
+          fail 'attributes must be in form of hash or array'
+        end
+      end
+    end
+
+    def validate_default_image_path!
+      return unless default_image_path_defined?
+      path = ArmaFixer::DEFAULT_IMAGE_PATH
+      fail 'ArmaFixer::DEFAULT_IMAGE_PATH must be a string' unless path.is_a?(String)
+      fail "file not found at '#{path}'" unless File.exist?(path)
+    end
+
+    def default_image
+      ArmaFixer::DEFAULT_IMAGE_PATH if default_image_path_defined?
+    end
+
+    def default_image_path_defined?
+      defined?(ArmaFixer::DEFAULT_IMAGE_PATH)
+    end
+
+    def validate_attribute_checker!
+      if defined?(ArmaFixer::ATTR_CHECKER)
+        unless ArmaFixer::ATTR_CHECKER.is_a?(Proc)
+          fail 'ArmaFixer::ATTR_CHECKER must be a lambda'
+        end
+      end
+    end
+  end
+end

data/lib/arma_fixer/version.rb

@@ -0,0 +1,3 @@
+module ArmaFixer
+  VERSION = '0.1.0'
+end

data/spec/lib/tasks/rake_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'rake'
+
+describe Rake do
+  subject(:run_task) { dc_task['armaf:run'].execute }
+
+  let(:this_file) { File.expand_path(__FILE__) }
+  let(:dc) { described_class }
+  let(:dc_task) { dc::Task }
+
+  let(:app) do
+    module TestingThis
+    end
+
+    TestingThis
+  end
+
+  let(:user_model) do
+    klass = Class.new
+    klass.class_eval do
+      attr_accessor :code_file, :id
+      def save
+        true
+      end
+
+      def self.ancestors
+        [ActiveRecord::Base, *super]
+      end
+    end
+
+    app.const_set(:User, klass) unless defined?(app::User)
+    app::User
+  end
+
+  let(:user_one) { user_model.new }
+  let(:user_two) do
+    user_model.new.tap do |user|
+      user.code_file = 123
+    end
+  end
+  let(:users_list) { [user_one, user_two] }
+
+  before do
+    allow(ArmaFixer).to receive(:puts).with(any_args) # suppressing output
+
+    expect(user_one).to receive(:save)
+    expect(user_two).to_not receive(:save)
+
+    dc.load_rakefile('Rakefile')
+    dc_task.define_task(:environment)
+    allow(user_model).to receive(:where).with('').and_return(users_list)
+
+    stub_const('ArmaFixer::APP', app)
+    stub_const('ArmaFixer::MODELS_HASH', models_hash)
+  end
+
+  describe 'rake armaf:run' do
+    after do
+      expect(user_one.code_file).to be_a File
+      expect(user_two.code_file).to eq 123
+    end
+
+    context 'MODELS_HASH is an array' do
+      before { stub_const('ArmaFixer::DEFAULT_IMAGE_PATH', this_file) }
+      let(:models_hash) { { user_model.to_s => [:code_file] } }
+      it { run_task }
+    end
+
+    context 'MODELS_HASH is a hash' do
+      let(:models_hash) { { user_model.to_s => { code_file: this_file } } }
+      it { run_task }
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: arma_fixer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Syed Humza Shah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.34.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.34.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Replace missing image files in your models with defaults.
+email:
+- humzashah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/arma_fixer/tasks/run.rake
+- lib/arma_fixer/execute.rb
+- lib/arma_fixer/railtie.rb
+- lib/arma_fixer/validation.rb
+- lib/arma_fixer/version.rb
+- lib/arma_fixer.rb
+- spec/lib/tasks/rake_spec.rb
+homepage: http://github.com/humzashah/arma_fixer
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thanks for installing ArmaFixer!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord Model Image Fixer
+test_files:
+- spec/lib/tasks/rake_spec.rb