vulcano 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 858726c7fc12dd257149ed09ddf7049e95a10d4c
+  data.tar.gz: 4fdd4db01089e306b8bb8ff55ed41ed5001a0515
+SHA512:
+  metadata.gz: 11b50ccf689d7b99fec91cbd61806429a44b69892d8d4886836ddd6817f5a893dffdf9807f4b910854535f5c409727d7ed39029157f95dfefb3e625b9ce067ef
+  data.tar.gz: f51e33bd72afcfaa0557d91b55b183a878ed7f63f74097592449802c48cba86a648a197b33dbfc3f14e7917096e127deaaf0cbaf7475ea890dd16415652f75d7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at franco.meloni91@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vulcan.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    vulcano (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vulcano!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Franco Meloni
+
+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,54 @@
+# Vulcano
+
+Ruby script to generate Swift Codable files from a JSON
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vulcano'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vulcano
+
+## Usage
+
+```bash
+vulcano json_path [output_folder]
+```
+
+#### Examples
+
+```
+vulcano /Users/franco/vulcan_json.json
+```
+
+```
+vulcano /Users/franco/vulcano_json.json /Users/franco/output_folder
+```
+
+## 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 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/f-meloni/vulcano. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Vulcano project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/vulcano/blob/master/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vulcan"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/vulcano

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'vulcano'
+
+main = Vulcano::Main.new.start

data/lib/vulcano/codable_generator.rb

@@ -0,0 +1,42 @@
+require "vulcano/parsed_class"
+require "vulcano/parsed_variable"
+
+module Vulcano
+  class CodableGenerator
+    def generate_codable_file(json, destination_folder, className = nil)
+      variables = []
+
+      json.each do |key, value|
+        parsed_object = parse_object(destination_folder, key, value)
+
+        variables.push(parsed_object) unless parsed_object.nil?
+      end
+
+      name = className.nil? ? 'Generated' : className
+
+      parsed_class = ParsedClass.new(name, variables)
+
+      spec = Gem::Specification.find_by_name('vulcano')
+      template = File.read("#{spec.gem_dir}/resources/TemplateFile.swift")
+
+      renderer = ERB.new(template)
+      result = renderer.result(parsed_class.class_binding)
+
+      File.open("#{destination_folder}/#{name}.swift", 'w') { |f| f.write(result) }
+    end
+
+    def parse_object(destination_folder, key, value)
+      return parse_object(destination_folder, key, value.first).array unless !value.is_a?(Array)
+
+      if value.is_a?(Hash)
+        generate_codable_file(value, destination_folder, class_name_from_key(key))
+      end
+
+      ParsedVariable.new(key, value)
+    end
+
+    def class_name_from_key(key)
+      key.camel_case
+    end
+  end
+end

data/lib/vulcano/codable_key.rb

@@ -0,0 +1,11 @@
+module Vulcano
+  class CodableKey
+    attr_reader :original_name
+    attr_reader :codable_name
+
+    def initialize(original_name, codable_name = nil)
+      @original_name = original_name
+      @codable_name = codable_name
+    end
+  end
+end

data/lib/vulcano/json_reader.rb

@@ -0,0 +1,8 @@
+module Vulcano
+  class JsonReader
+    def read_from_file(file_path)
+      file = File.read(file_path)
+      JSON.parse(file)
+    end
+  end
+end

data/lib/vulcano/parsed_class.rb

@@ -0,0 +1,40 @@
+require "vulcano/codable_key"
+
+module Vulcano
+  class ParsedClass
+    attr_reader :name
+    attr_reader :variables
+    attr_reader :codable_keys
+
+    def initialize(name, variables)
+      @name = name
+      @variables = variables
+      @codable_keys = codable_keys
+    end
+
+    def class_binding
+      binding
+    end
+
+    private
+
+    def codable_keys
+      codable_keys = []
+
+      has_codable_keys = false
+
+      variables.each do |variable|
+        if variable.name == variable.original_name
+          codable_keys.push(CodableKey.new(variable.original_name))
+        else
+          codable_keys.push(CodableKey.new(variable.original_name, variable.name))
+          has_codable_keys = true
+        end
+      end
+
+      return nil unless has_codable_keys
+
+      codable_keys
+    end
+  end
+end

data/lib/vulcano/parsed_variable.rb

@@ -0,0 +1,36 @@
+module Vulcano
+  class ParsedVariable
+    attr_reader :original_name
+    attr_reader :value
+    attr_reader :type
+
+    def initialize(key, value, type = nil)
+      @original_name = key
+      @value = value
+      @type = type
+    end
+
+    def name
+      original_name.camel_case_lower
+    end
+
+    def array
+      ParsedVariable.new(original_name, nil, "[#{type}]")
+    end
+
+    def type
+      return @type unless @type.nil?
+
+      case value
+      when Integer then 'Int'
+      when Float then 'Float'
+      when String then 'String'
+      when TrueClass then 'Boolean'
+      when FalseClass then 'Boolean'
+      when Hash then original_name.camel_case
+      else
+        raise "Unknown type: #{value.class}"
+      end
+    end
+  end
+end

data/lib/vulcano/version.rb

@@ -0,0 +1,3 @@
+module Vulcano
+  VERSION = "0.3.0"
+end

data/lib/vulcano.rb

@@ -0,0 +1,31 @@
+require "vulcano/version"
+require "vulcano/json_reader"
+require "vulcano/codable_generator"
+require "json"
+require "erb"
+
+module Vulcano
+  class Main
+    def start
+      raise RuntimeError, 'The script has to be called with a JSON path' unless ARGV.length > 0
+
+      json_path = ARGV[0]
+      destination_folder = ARGV[1].nil? ? "." : ARGV[1]
+      json = JsonReader.new.read_from_file(json_path)
+      CodableGenerator.new.generate_codable_file(json, destination_folder)
+    end
+  end
+end
+
+class String
+  def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map(&:capitalize).join
+  end
+
+  def camel_case_lower
+    split('_').inject([]) do |buffer, e|
+      buffer.push(buffer.empty? ? e : e.capitalize)
+    end.join
+  end
+end

data/resources/TemplateFile.swift

@@ -0,0 +1,7 @@
+class <%= @name %>: Codable {<% for @variable in @variables %>
+    var <%= @variable.name %>: <%= @variable.type %><% end %><% if (@codable_keys != nil) then %>
+    
+    enum CodingKeys: String, CodingKey { <% for @codable_key in @codable_keys %>
+        <% if (@codable_key.codable_name != nil) then %> case <%= @codable_key.codable_name %> = "<%= @codable_key.original_name %>"<% else %> case <%= @codable_key.original_name %><% end %><% end %>
+    }<% end %>
+}

data/vulcano.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vulcano/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vulcano"
+  spec.version       = Vulcano::VERSION
+  spec.authors       = ["Franco Meloni"]
+  spec.email         = ["franco.meloni91@gmail.com"]
+
+  spec.summary       = %q{Codable files genertator}
+  spec.description   = %q{This script takes in input a path to a json file and generates the Codable files for that json}
+  spec.homepage      = "https://github.com/f-meloni/vulcano"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["vulcano"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: vulcano
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Franco Meloni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-12 00:00:00.000000000 Z
+dependencies:
+- !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: '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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This script takes in input a path to a json file and generates the Codable
+  files for that json
+email:
+- franco.meloni91@gmail.com
+executables:
+- vulcano
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/vulcano
+- lib/vulcano.rb
+- lib/vulcano/codable_generator.rb
+- lib/vulcano/codable_key.rb
+- lib/vulcano/json_reader.rb
+- lib/vulcano/parsed_class.rb
+- lib/vulcano/parsed_variable.rb
+- lib/vulcano/version.rb
+- resources/TemplateFile.swift
+- vulcano.gemspec
+homepage: https://github.com/f-meloni/vulcano
+licenses:
+- MIT
+metadata: {}
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Codable files genertator
+test_files: []