uncruft 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 872b086c546d40b77f15ad5151c489ed5252650933a973cb6d8c4c8875c6e34c
-  data.tar.gz: dc4827ef98f9074dfb8fd69cc2f9b65a5c748ede3c8c170cf05e941c8118f438
+  metadata.gz: 0574a8f06a56e8a78866055e1a06e190dbd98925c956deaf66c035f20f4fda7b
+  data.tar.gz: c4a7eeeb9cfb6bf8d565a81c798b9688f5307a97ba597187063c2914e054101d
 SHA512:
-  metadata.gz: dc79959ad5e277af441da4078096c364fe0d2da1b1dcc4edf669a0c8531a26a6412d185c424aedabe204a1699d34abdfa251de919f83ad74add09c37c5632bf8
-  data.tar.gz: dec28f5ebf6cbfffa6c5c4d1b0afbd5b363fce562c6dfed8c62b374d064ac9d47e5382ed1b7c486098edfb1c089058bafb52ba517a202328b698f6d2200d2d09
+  metadata.gz: 1fe67350e730b54703a2267a3f8513684cc94840d8a81085b081d45a1f73bd9db1e4adb9c6a9e32980815f002ef1f27aa178090c6e4b80713f3cd507a6db52e9
+  data.tar.gz: fd800818c479fdac5e7b286eae6248f19b35a2f75ae8de946a2d850db91c968dc9d6c7a7e0d9049eff1059a990d1244f0035bfb750c2fdc78bfd879aac914960

data/README.md

@@ -39,6 +39,29 @@ You can also incrementally add new warnings to the ignorefile as you encounter t
 RECORD_DEPRECATIONS=1 rspec path/to/my/failing/spec.rb
 ```
 
+## Deprecating Attributes and Methods
+
+If you would like to deprecate an attribute by applying a `ActiveSupport::Deprecation` warning on the deprecated attribute's getters and setters then look no further, we have a tool for that! Simply include `Uncruft::Deprecatable` in your class, identify the attribute you would like deprecated and provide a message you would like applied to the deprecation warning.
+
+```ruby
+class Customer
+  include Uncruft::Deprecatable
+
+  attr_accessor :first_name
+
+  def initialize(first_name)
+    @first_name = first_name
+  end
+
+  deprecate_attribute(:first_name,
+                      message: "Please stop using first_name it is deprecated, please use legal_first_name instead!")
+end
+```
+
+Within the `Uncruft::Deprecatable` module there is also a `.deprecate_method` method that can be used to apply a deprecation warning to an identified method, much like the `deprecate_attribute` method described above.
+
+From there you can use Uncruft's deprecation recording tools to generate ingorefiles and manage your deprecation backlog in an organized manner.
+
 ## How to Contribute
 
 We would love for you to contribute! Anything that benefits the majority of users—from a documentation fix to an entirely new feature—is encouraged.

data/lib/uncruft.rb

@@ -1,6 +1,7 @@
 require 'uncruft/version'
 require 'uncruft/railtie'
 require 'uncruft/deprecation_handler'
+require 'uncruft/deprecatable'
 require 'uncruft/warning'
 
 module Uncruft

data/lib/uncruft/deprecatable.rb

@@ -0,0 +1,25 @@
+module Uncruft
+  module Deprecatable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def deprecate_attribute(attribute, message:)
+        deprecate_method attribute, message: message
+        deprecate_method :"#{attribute}=", message: message
+      end
+
+      def deprecate_method(method, message:)
+        prepended_method = Module.new
+
+        prepended_method.module_eval do
+          define_method method do |*args, &block|
+            ActiveSupport::Deprecation.warn(message)
+            super(*args, &block)
+          end
+        end
+
+        prepend prepended_method
+      end
+    end
+  end
+end

data/lib/uncruft/version.rb

@@ -1,3 +1,3 @@
 module Uncruft
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/uncruft/deprecatable_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+RSpec.describe Uncruft::Deprecatable do
+  let(:my_name) { "Jess" }
+
+  subject { klass.new }
+
+  describe '.deprecate_attribute' do
+    let(:klass) do
+      Class.new do
+        include Uncruft::Deprecatable
+
+        attr_accessor :first_name
+
+        deprecate_attribute(:first_name,
+          message: "Please stop using this attribute!")
+      end
+    end
+
+    it 'applies deprecation warning when setting deprecated attribute' do
+      expect(ActiveSupport::Deprecation).to receive(:warn).once
+        .with("Please stop using this attribute!")
+
+      expect(subject.first_name = my_name).to eq my_name
+    end
+
+    it 'applies deprecation warning when getting deprecated attribute' do
+      subject.instance_variable_set(:@first_name, my_name)
+
+      expect(ActiveSupport::Deprecation).to receive(:warn)
+        .with("Please stop using this attribute!")
+
+      expect(subject.first_name).to eq my_name
+    end
+  end
+
+  describe '.deprecate_method' do
+    let(:klass) do
+      Class.new do
+        include Uncruft::Deprecatable
+
+        def legacy_method
+          "Hello Old World!"
+        end
+
+        deprecate_method(:legacy_method,
+          message: "Please stop using this method!")
+      end
+    end
+
+    it 'applies deprecation warning when calling the deprecated method' do
+      expect(ActiveSupport::Deprecation).to receive(:warn)
+        .with("Please stop using this method!")
+
+      expect(subject.legacy_method).to eq "Hello Old World!"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uncruft
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nathan Griffith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -107,6 +107,7 @@ files:
 - README.md
 - Rakefile
 - lib/uncruft.rb
+- lib/uncruft/deprecatable.rb
 - lib/uncruft/deprecation_handler.rb
 - lib/uncruft/railtie.rb
 - lib/uncruft/version.rb
@@ -116,6 +117,7 @@ files:
 - spec/examples.txt
 - spec/spec_helper.rb
 - spec/support/rails_root.rb
+- spec/uncruft/deprecatable_spec.rb
 - spec/uncruft/deprecation_handler_spec.rb
 - spec/uncruft/railtie_spec.rb
 - spec/uncruft/warning_spec.rb
@@ -150,6 +152,7 @@ test_files:
 - spec/examples.txt
 - spec/uncruft/railtie_spec.rb
 - spec/uncruft/warning_spec.rb
+- spec/uncruft/deprecatable_spec.rb
 - spec/uncruft/deprecation_handler_spec.rb
 - spec/support/rails_root.rb
 - spec/uncruft_spec.rb