highlighter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1bb5ff98b735f8db19cce93c9c60a1770583bfe79f4f2eafde3edb416ac1720c
+  data.tar.gz: abe29e519393a81c5c3dd5f4aa75c065584695c910badc26207a4d6295f30e1f
+SHA512:
+  metadata.gz: a0fa614bdeac9734737e552c2a3ca2081dfe1359b03786d818d315049433164e2e1488a96071c32d190bd0d57ab0e8a10b6529b4ebca1f1cdca13eb5416fafb1
+  data.tar.gz: 1a698647c970a53d078f66093452593b84b5bbac22dde8f5d5a9e9180da73ed8cf2ad7f6048dac0d7d6f562398e56b6f8e146901adfed3223c89140ed9801308

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.1.2
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in highlighter.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    highlighter (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  highlighter!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Caio Rodriguez
+
+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,101 @@
+# Highlighter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/highlighter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'highlighter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install highlighter
+
+## Usage
+
+```ruby
+class User
+  attr_accessor :id, :name, :cars
+
+  def initialize(id:, name:, cars:)
+    @id = id
+    @name = name
+    @cars = cars
+  end
+end
+```
+```ruby
+class Car
+  attr_accessor :id, :name, :manufacturer
+
+  def initialize(id:, name:, manufacturer:)
+    @id = id
+    @name = name
+    @manufacturer = manufacturer
+  end
+end
+```
+Then, we should define one serializer for each class:
+```ruby
+class CarSerializer
+  include Highlighter::Serializer
+
+  attribute :id
+  attribute :name
+  attribute :manufacturer
+end
+```
+```ruby
+class UserSerializer
+  include Highlighter::Serializer
+
+  attribute :id
+  attribute :name
+  attribute :cars, serializer: CarSerializer
+end
+```
+```ruby
+cars = [
+      Car.new(id: 1, name: 'Polo', manufacturer: 'VW'),
+      Car.new(id: 2, name: 'Focus', manufacturer: 'Ford')
+    ]
+user = User.new(id: 1, name: "Kelly", cars: cars)
+```
+Now that we have the instances of cars and user in place we just need to instatiate the serializer and call `to_h`
+```ruby
+UserSerializer.new(user).to_h
+```
+And it will return:
+```ruby
+{
+  id: 1,
+  name: "Kelly",
+  cars: [
+          { id: 0, manufacturer: 'Polo', name: 'VW' },
+          { id: 1, manufacturer: 'Focus', name: 'Ford' },
+        ]
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 the created tag, 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/CaioPenhalver/highlighter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/highlighter.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/highlighter/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "highlighter"
+  spec.version = Highlighter::VERSION
+  spec.authors = ["Caio Rodriguez"]
+  spec.email = ["caio.rodriguez.dev@gmail.com"]
+
+  spec.summary = "A simple way to serializer ruby objects"
+  spec.description = "Serializer ruby objects in simple and straightforward way"
+  spec.homepage = "https://github.com/CaioPenhalver/highlighter"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.2"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/CaioPenhalver/highlighter"
+  spec.metadata["changelog_uri"] = "https://github.com/CaioPenhalver/highlighter/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/highlighter/attribute.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Highlighter
+  # Holds info on attribute
+  class Attribute
+    attr_reader :name, :serializer
+
+    def initialize(name:, serializer: nil)
+      @name = name
+      @serializer = serializer
+    end
+  end
+end

data/lib/highlighter/serializer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Highlighter
+  # Responsible for instantiating and serializing objects
+  module Serializer
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def initialize(object)
+      @object = object
+    end
+
+    def to_h
+      self.class.attributes.each_with_object({}) do |attr, hash|
+        hash[attr.name] = serialize_attribute(attr)
+        hash
+      end
+    end
+
+    def serialize_attribute(attr)
+      value = @object.send(attr.name)
+      return serialize_array(value, attr) if value.instance_of? Array
+
+      apply_serializer(value, attr)
+    end
+
+    def serialize_array(array, attr)
+      array.map do |value|
+        apply_serializer(value, attr)
+      end
+    end
+
+    def apply_serializer(value, attr)
+      return value if attr.serializer.nil?
+
+      attr.serializer.new(value).to_h
+    end
+
+    # Add methods to expose and set up attributes
+    module ClassMethods
+      def attribute(name, serializer: nil)
+        instance_variable_set(:@attributes, []) unless instance_variable_defined?(:@attributes)
+        instance_variable_get(:@attributes) << Attribute.new(name:, serializer:)
+      end
+
+      def attributes
+        instance_variable_get(:@attributes)
+      end
+    end
+  end
+end

data/lib/highlighter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Highlighter
+  VERSION = "0.1.0"
+end

data/lib/highlighter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "highlighter/version"
+require_relative "highlighter/serializer"
+require_relative "highlighter/attribute"
+
+module Highlighter
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/highlighter.rbs

@@ -0,0 +1,4 @@
+module Highlighter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: highlighter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caio Rodriguez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-20 00:00:00.000000000 Z
+dependencies: []
+description: Serializer ruby objects in simple and straightforward way
+email:
+- caio.rodriguez.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- highlighter.gemspec
+- lib/highlighter.rb
+- lib/highlighter/attribute.rb
+- lib/highlighter/serializer.rb
+- lib/highlighter/version.rb
+- sig/highlighter.rbs
+homepage: https://github.com/CaioPenhalver/highlighter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CaioPenhalver/highlighter
+  source_code_uri: https://github.com/CaioPenhalver/highlighter
+  changelog_uri: https://github.com/CaioPenhalver/highlighter/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A simple way to serializer ruby objects
+test_files: []