tanoshimu_utils 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d89a89ee2a88ac4a6c6ba96c98a4b158d29fbd71ec306c1b2934d09e7cdf495
-  data.tar.gz: d2eea7a91e7fefc67beb18d1947e9a213700d6ac168c9bcdff25596860d97646
+  metadata.gz: e12e51d76c696e382e40ef43dc59ad97eb5479441925a8d8f638cf771344708e
+  data.tar.gz: 885046472e52bcb839e2e77e76d623815a3de6b4b144ef9bff72c17ac3e5fa53
 SHA512:
-  metadata.gz: 05df987581a2076776af93969b5575ad5c379b895fbae54a5189b26944ea5c0ddc7f68ed5f4d20f15334533a494ab367143197da7020bd7d75ab21310623d62f
-  data.tar.gz: 4b4c0787f53d8577611e256d0caff4f37d1d802a220a6703dee1f7b51a1993c04f73b46413f55f29dfd292a5ae2c56d21a42f5e6048a18aaab6da1ba97a85f4b
+  metadata.gz: 41ea0070f7a5e72c96b9e42ca810d65b5feeb1efb874081428287919e673e192c655278df64a7b299d710446c0a8b4aa09d93c448ffb8000ef8c342542325b73
+  data.tar.gz: 4dc444e942cc31c5837d366b8b16436e46f5fec5390cdfecab297ae788d37fdd44231856e3c5be7822e35117c8053f80b13d1a73e3f2af399686393ef5da089a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Akinyele Cafe-Febrissy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# YourAnime.moe utilities
+
+Welcome to `tanoshimu_utils`! This gem is what I like to call "just a couple of utilities shared accross the apps to make development much easier."
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tanoshimu_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tanoshimu_utils
+
+## Usage
+
+### Concerns
+
+| `include`                                  | Description | Example |
+| ------------------------------------------ | ----------- | ------- |
+| `TanoshimuUtils::Concerns::GetRecord`      | Add `.record` to return a model from the table `.used_by_model` with primary key `.model_id`. | `Model.first.record` |
+| `TanoshimuUtils::Concerns::Identifiable`   | Fills up the `.identification` field with a unique token. | Use with classes like `Admin`, `User`, `Staff`, etc... (anyone that can log on to the app) |
+| `TanoshimuUtils::Concerns::ResourceFetch`  | For an ActiveStorage attachment `res`, adds `res_url` (get the url), `res_url!` (fetch from AWS), `res?` (make sure it is existant and attached) | Use classes that have attachments (like images). If `user` has `avatar`, then `user.avatar?`, `user.avatar_url`, `user.avatar_url!` are valid calls. |
+| `TanoshimuUtils::Concerns::RespondToTypes` | Adds `respond_to_types` class method to add `field?` for a field `field`. | `respond_to_types [:admin, :regular, :guest]` is a valid class for a `User` class. |
+| `TanoshimuUtils::Concerns::Translatable`   | Depending on the current locale, adds a `translates` class method to create a field that returns the value | `translates :value, through: [:en, :fr], default: :fr` creates a method `.value` that returns the field `.fr` if the locale is French, `.en` if the locale is English. French is returned if another available locale is set. |
+
+### Validators
+
+| `include`                                   | Description | Example |
+| ------------------------------------------- | ----------- | ------- |
+| `TanoshimuUtils::Validators::PresenceOneOf` | Adds the class method `validate_presence_one_of` to check if at lease one of the fields are set. | `validate_presence_one_of [:field1, :field2, :field3]` will validate if `:field1` or `field2` or `field3` is set. If none are set, fails. |
+| `TanoshimuUtils::Validators::UserLike`      | Adds the class method `validate_like_user` to check if the user-like class (`User`, `Admin`, `Staff`, etc.) has a `name`, a `username` and a `user_type` (the latter must be in the array `user_types`). | `validate_like_user user_types: [:admin, :regular]` only allows user-like models to be either admin or regular. |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tanoshimu_utils.

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'TanoshimuUtils'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/tanoshimu_utils/concerns/resource_fetch.rb

@@ -2,13 +2,13 @@ module TanoshimuUtils
   module Concerns
     module ResourceFetch
       extend ActiveSupport::Concern
-    
-      class ResourceNotAttachable < StandardError
+
+      class ResourceNotAttachable < TanoshimuUtils::Error
         def initialize(resource_name)
           super("Resource #{resource_name} not attachable.")
         end
       end
-    
+
       class_methods do
         def has_resource(resource_name, default_url: '/', expiry: 1.day)
           resource_url = :"#{resource_name}_url"
@@ -23,7 +23,7 @@ module TanoshimuUtils
           send(:define_method, "#{resource_url}!") do
             attachment = resource_for(resource_name).attachment
             return default_url if attachment.nil?
-    
+
             if Config.uses_disk_storage?
               Rails.application.routes.url_helpers.rails_blob_url(attachment, only_path: true)
             else
@@ -34,6 +34,7 @@ module TanoshimuUtils
             (fetch!(resource_name, default_url)&.attached?).present?
           end
           send(:define_method, "generate_#{resource_name}_url!") do
+            return nil unless persisted?
             return true if send("#{resource_url}?") && !force
 
             new_url = send("#{resource_url}!")
@@ -41,87 +42,9 @@ module TanoshimuUtils
           end
         end
       end
-    
-      private
-    
-      def resource_for(resource_name)
-        method(resource_name).call
-      end
-    
-      def resource_url_for(resource_name, default_url: '/', expiry: 1.day)
-        ensure_attachable_resource!(resource_name)
-        resource_url = :"#{resource_name}_url"
-        if try(:"db_#{resource_url}?")
-          self[resource_url] || default_url
-        else
-          resource = resource_for(resource_name)
-          if resource.attached?
-            resource.service_url(expires_in: expiry)
-          else
-            default_url
-          end
-        end
-      end
-    
-      def fetch!(resource_name, default_url)
-        ensure_attachable_resource!(resource_name)
-        resource = resource_for(resource_name)
-        #return resource if resource.attached?
-    
-        #resource.attach(io: File.open("./public/#{default_url}"), filename: "episode-#{id}")
-    
-      rescue ResourceFetch::ResourceNotAttachable, Errno::ENOENT
-        nil
-      end
-    
-      def ensure_fetchable_resource!(resource_name)
-        raise NoMethodError, "Don't know how to fetch #{resource_name}" unless respond_to?(resource_name)
-      end
-    
-      def ensure_attachable_resource!(resource_name)
-        resource_for(resource_name)
-      rescue NameError
-        raise ResourceFetch::ResourceNotAttachable.new(resource_name)#, resource unless resource.respond_to?(:attached?)
-      end
-    end
-    module ResourceFetch
-      extend ActiveSupport::Concern
-    
-      class ResourceNotAttachable < StandardError
-        def initialize(resource_name)
-          super("Resource #{resource_name} not attachable.")
-        end
-      end
-    
-      class_methods do
-        def has_resource(resource_name, default_url: '/', expiry: 1.day)
-          resource_url = :"#{resource_name}_url"
-          db_resource_url = :"db_#{resource_url}?"
-          send(:define_method, db_resource_url) do
-            @db_resource_url ||= self.class.column_names.include?(resource_url.to_s)
-          end
-          send(:define_method, resource_url) do
-            ensure_fetchable_resource!(resource_name)
-            resource_url_for(resource_name, default_url: default_url, expiry: expiry)
-          end
-          send(:define_method, "#{resource_url}!") do
-            attachment = resource_for(resource_name).attachment
-            return default_url if attachment.nil?
-    
-            if Config.uses_disk_storage?
-              Rails.application.routes.url_helpers.rails_blob_url(attachment, only_path: true)
-            else
-              attachment.service_url(expires_in: expiry)
-            end
-          end
-          send(:define_method, "#{resource_name}?") do
-            (fetch!(resource_name, default_url)&.attached?).present?
-          end
-        end
-      end
-    
+
       private
-    
+
       def resource_for(resource_name)
         method(resource_name).call
       end
@@ -161,6 +84,6 @@ module TanoshimuUtils
       rescue NameError
         raise ResourceFetch::ResourceNotAttachable.new(resource_name)#, resource unless resource.respond_to?(:attached?)
       end
-    end        
+    end   
   end
 end

data/lib/tanoshimu_utils/concerns/translatable.rb

@@ -2,39 +2,39 @@ module TanoshimuUtils
   module Concerns
     module Translatable
       extend ActiveSupport::Concern
-    
+
       def metaclass
         class << self
           self
         end
       end
-    
+
       class_methods do
         def translates(field, through: [], default:)
           raise 'Field must be present' unless field.present?
           raise 'Through must be present' unless through.present?
-    
+
           if column_names.include?(field.to_s)
             raise 'Field must not be defined on the model'
           end
-    
-          through = [through] unless through.kind_of?(Array)
+
+          through = [through] unless through.is_a?(Array)
           default = default.to_sym
-    
+
           unless I18n.available_locales.include?(default)
-            raise "#{default} is not available on your system as a locale"
+            warn "#{default} is not available on your system as a locale"
           end
-    
+
           send(:define_method, field.to_sym) do
             through.each do |possible_locale|
               possible_locale = possible_locale.to_sym
-    
+
               unless I18n.available_locales.include?(possible_locale)
                 next
               end
             end
-    
             return nil unless through.include?(I18n.locale)
+
             value = send(I18n.locale)
             value = send(default) if value.nil? && default
             value
@@ -43,4 +43,4 @@ module TanoshimuUtils
       end
     end
   end
-end
+end

data/lib/tanoshimu_utils/railtie.rb

@@ -0,0 +1,4 @@
+module TanoshimuUtils
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/tanoshimu_utils/version.rb

@@ -1,3 +1,3 @@
 module TanoshimuUtils
-  VERSION = '1.2.2'
+  VERSION = '2.0.0'
 end

data/lib/tanoshimu_utils.rb

@@ -1,10 +1,15 @@
 require 'active_support'
-
 require 'tanoshimu_utils/version'
-require_relative 'tanoshimu_utils/concerns'
-require_relative 'tanoshimu_utils/validators'
 
 module TanoshimuUtils
-  class Error < StandardError; end
-  # Your code goes here...
+  class Error < StandardError
+    def initialize(message = nil)
+      message ||= 'Unknow error.'
+      super("[TanoshimuUtils-#{VERSION}]: #{message}")
+    end
+  end
 end
+
+require 'tanoshimu_utils/railtie'
+require_relative 'tanoshimu_utils/concerns'
+require_relative 'tanoshimu_utils/validators'

data/lib/tasks/tanoshimu_utils_tasks.rake

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

metadata

@@ -1,51 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: tanoshimu_utils
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Akinyele Cafe-Febrissy
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
+        version: 6.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -60,6 +60,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - lib/tanoshimu_utils.rb
 - lib/tanoshimu_utils/concerns.rb
 - lib/tanoshimu_utils/concerns/get_record.rb
@@ -67,12 +70,15 @@ files:
 - lib/tanoshimu_utils/concerns/resource_fetch.rb
 - lib/tanoshimu_utils/concerns/respond_to_types.rb
 - lib/tanoshimu_utils/concerns/translatable.rb
+- lib/tanoshimu_utils/railtie.rb
 - lib/tanoshimu_utils/validators.rb
 - lib/tanoshimu_utils/validators/presence_one_of.rb
 - lib/tanoshimu_utils/validators/user_like.rb
 - lib/tanoshimu_utils/version.rb
-homepage: https://github.com/thedrummeraki/tanoshimu/tree/heroku/tanoshimu_utils
-licenses: []
+- lib/tasks/tanoshimu_utils_tasks.rake
+homepage: https://github.com/thedrummeraki/tanoshimu_utils
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []