jsup 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 6ed62761a98e6269a7daba03d1ca8f14e234d51f
4
+ data.tar.gz: c621ed095bc68ed27946f75fb9cc76caf2025d21
5
+ SHA512:
6
+ metadata.gz: d4f13a5090a0622b2c686ef922ed59d29610a70e2b2bfeef94574d1f6dabffc6039114f25b8a2ec34053f6fc2a5575134e079030a869584566db323aea241c32
7
+ data.tar.gz: 93bae3b13d14be76977e3adc99be4255462ac931e320ce25a0b681e38d1bebdb696f2a5cee7650cb9525f3d7176ffbef410e82e4f68d6c0f131e9caf9db8d250
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.0
5
+ before_install: gem install bundler -v 1.14.3
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at wizard.oneandonly@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in jsup.gemspec
4
+ gemspec
5
+ gem 'byebug', require: false
6
+ gem 'codecov', require: false, group: :test
7
+ gem 'oj'
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Stefan Slaveykov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,129 @@
1
+ # Jsup
2
+ [![Build Status](https://travis-ci.org/wizardone/jsup.svg?branch=master)](https://travis-ci.org/wizardone/jsup)
3
+
4
+ Jsup produces json using oj. It is really fast, simple and reliable. If
5
+ speed is what you are looking for in your APIs then you should check it
6
+ out.
7
+ If you have a complex architecture you should probably check gems like
8
+ `roar`, `jbuilder`, `serializers` etc.
9
+
10
+ ## Installation
11
+
12
+ Add this line to your application's Gemfile:
13
+
14
+ ```ruby
15
+ gem 'jsup'
16
+ ```
17
+
18
+ And then execute:
19
+
20
+ `bundle`
21
+
22
+ Or install it yourself as:
23
+
24
+ `gem install jsup`
25
+
26
+ ## Usage
27
+ ```ruby
28
+ user = User.first
29
+ Jsup.produce do |j|
30
+ j.name user.name
31
+ j.email user.email
32
+ end
33
+ ```
34
+ Will produce:
35
+ ```json
36
+ {
37
+ "name": "John",
38
+ "email": "john@johnson.com"
39
+ }
40
+ ```
41
+
42
+ ```ruby
43
+ Jsup.produce do |j|
44
+ j.name 'Stefan'
45
+ j.fetch(@address, :city)
46
+ end
47
+ ```
48
+ Will produce:
49
+ ```json
50
+ {
51
+ "name": "Stefan",
52
+ "city": "Sofia"
53
+ }
54
+ ```
55
+ You can fetch multiple attributes:
56
+ ```ruby
57
+ j.fetch(@address, :city, :zip_code, :street)
58
+ ```
59
+
60
+ You can also produce nested content:
61
+ ```ruby
62
+ Jsup.produce do |j|
63
+ j.name 'Stefan'
64
+ j.address do |ja|
65
+ ja.street '13 march'
66
+ ja.city 'Sofia'
67
+ end
68
+ end
69
+ ```
70
+ Will produce:
71
+ ```json
72
+ {
73
+ "name": "Stefan",
74
+ "address":
75
+ {
76
+ "street": "13 march",
77
+ "city": "Sofia"
78
+ }
79
+ }
80
+ ```
81
+
82
+ ## Benchmarking
83
+ For rather simple data structures jsup is way faster than jbuilder:
84
+ ```ruby
85
+ def jb
86
+ Jbuilder.encode do |person|
87
+ person.name 'Stefan'
88
+ person.email 'test@test.com'
89
+ person.address 'some'
90
+ end
91
+ end
92
+
93
+ def js
94
+ Jsup.produce do |person|
95
+ person.name 'Stefan'
96
+ person.email 'test@test.com'
97
+ person.address 'some'
98
+ end
99
+ end
100
+
101
+
102
+ Benchmark.bm do |x|
103
+ x.report('jbuilder') { 10000.times { jb } }
104
+ x.report('jsup') { 10000.times { js } }
105
+ end
106
+ ```
107
+ Results:
108
+ ```shell
109
+ user system total real
110
+ jbuilder 0.110000 0.000000 0.110000 ( 0.112200)
111
+ jsup 0.030000 0.000000 0.030000 ( 0.025732)
112
+ ```
113
+
114
+
115
+ ## Development
116
+
117
+ 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.
118
+
119
+ 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).
120
+
121
+ ## Contributing
122
+
123
+ Bug reports and pull requests are welcome on GitHub at https://github.com/wizardone/jsup. 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.
124
+
125
+
126
+ ## License
127
+
128
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
129
+
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "jsup"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,36 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "jsup"
8
+ spec.version = Jsup::VERSION
9
+ spec.authors = ["Stefan Slaveykov"]
10
+ spec.email = ["wizard.oneandonly@gmail.com"]
11
+
12
+ spec.summary = %q{Build json fast}
13
+ spec.description = %q{Jsup helps you build fast json responses for your apis}
14
+ spec.homepage = "http://github.com/wizardone/jsup"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ #if spec.respond_to?(:metadata)
20
+ # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
21
+ #else
22
+ # raise "RubyGems 2.0 or newer is required to protect against " \
23
+ # "public gem pushes."
24
+ #end
25
+
26
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
27
+ f.match(%r{^(test|spec|features)/})
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ spec.add_development_dependency "bundler", "~> 1.14"
34
+ spec.add_development_dependency "rake", "~> 10.0"
35
+ spec.add_development_dependency "rspec", "~> 3.0"
36
+ end
@@ -0,0 +1,47 @@
1
+ require 'version'
2
+ require 'oj'
3
+
4
+ class Jsup
5
+
6
+ attr_reader :attributes
7
+
8
+ Oj.default_options = {
9
+ allow_blank: true,
10
+ use_as_json: true
11
+ }
12
+
13
+ def self.produce
14
+ new.tap do |json|
15
+ yield json
16
+ end.ojify
17
+ end
18
+
19
+ def ojify
20
+ Oj.dump(attributes)
21
+ end
22
+
23
+ def initialize
24
+ @attributes = Hash.new
25
+ end
26
+
27
+ private
28
+
29
+ def method_missing(method, *args, &block)
30
+ if args.length == 1
31
+ add_attribute(method.to_s, args.first)
32
+ elsif args.length > 1
33
+ object = args.first
34
+ attrs = args[1..args.length]
35
+ attrs.each do |attr|
36
+ add_attribute(attr.to_s, object.public_send(attr)) if object.respond_to?(attr)
37
+ end
38
+ elsif block_given?
39
+ nested_attributes = Jsup.new.tap { |json| yield json }.attributes
40
+ add_attribute(method.to_s, nested_attributes)
41
+ end
42
+ end
43
+
44
+ def add_attribute(method, attribute)
45
+ attributes[method] = attribute
46
+ end
47
+ end
@@ -0,0 +1,3 @@
1
+ class Jsup
2
+ VERSION = '0.1.0'
3
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jsup
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Stefan Slaveykov
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-05-25 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.14'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Jsup helps you build fast json responses for your apis
56
+ email:
57
+ - wizard.oneandonly@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - jsup.gemspec
73
+ - lib/jsup.rb
74
+ - lib/version.rb
75
+ homepage: http://github.com/wizardone/jsup
76
+ licenses:
77
+ - MIT
78
+ metadata: {}
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubyforge_project:
95
+ rubygems_version: 2.6.8
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: Build json fast
99
+ test_files: []