riddler 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1b32f298a7e738b115d8f94de7f1262566920a8ccc3acf51ae18c5219059772a
4
+ data.tar.gz: 65b5aaae401daf2614a0d0b63cf24c316b0016b6d444c534f4e026ab3584ad13
5
+ SHA512:
6
+ metadata.gz: d2a7ad3240490a19b32b775d05b1dee2087949f73e49a489ea66d1e9a9562ea7dcfcbcc3386fe819dd6bbc935af30d9fa4cce6931c7d87ff5fe49a95d7260f8a
7
+ data.tar.gz: 7bb507769931285c23feb392f46e57adfd107130465d355357aaa42f7ace4e70b54fe6fc31af798451173e38f3d723a4306810b858562ba62a1cfff8772f2af7
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.5.3
7
+ before_install: gem install bundler -v 1.17.1
@@ -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 ubergeek3141@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,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in riddler.gemspec
6
+ gemspec
@@ -0,0 +1,58 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ riddler (0.1.0)
5
+ ksuid
6
+ liquid
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ coderay (1.1.2)
12
+ ffi (1.9.25)
13
+ formatador (0.2.5)
14
+ guard (2.15.0)
15
+ formatador (>= 0.2.4)
16
+ listen (>= 2.7, < 4.0)
17
+ lumberjack (>= 1.0.12, < 2.0)
18
+ nenv (~> 0.1)
19
+ notiffany (~> 0.0)
20
+ pry (>= 0.9.12)
21
+ shellany (~> 0.0)
22
+ thor (>= 0.18.1)
23
+ ksuid (0.1.0)
24
+ liquid (4.0.1)
25
+ listen (3.1.5)
26
+ rb-fsevent (~> 0.9, >= 0.9.4)
27
+ rb-inotify (~> 0.9, >= 0.9.7)
28
+ ruby_dep (~> 1.2)
29
+ lumberjack (1.0.13)
30
+ method_source (0.9.2)
31
+ minitest (5.11.3)
32
+ nenv (0.3.0)
33
+ notiffany (0.1.1)
34
+ nenv (~> 0.1)
35
+ shellany (~> 0.0)
36
+ pry (0.12.2)
37
+ coderay (~> 1.1.0)
38
+ method_source (~> 0.9.0)
39
+ rake (10.5.0)
40
+ rb-fsevent (0.10.3)
41
+ rb-inotify (0.9.10)
42
+ ffi (>= 0.5.0, < 2)
43
+ ruby_dep (1.5.0)
44
+ shellany (0.0.1)
45
+ thor (0.20.3)
46
+
47
+ PLATFORMS
48
+ ruby
49
+
50
+ DEPENDENCIES
51
+ bundler (~> 1.17)
52
+ guard
53
+ minitest (~> 5.0)
54
+ rake (~> 10.0)
55
+ riddler!
56
+
57
+ BUNDLED WITH
58
+ 1.17.1
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 JohnnyT
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,41 @@
1
+ # Riddler
2
+
3
+ Riddler is a dynamic content and workflow engine.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'riddler'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install riddler
20
+
21
+ ## Usage
22
+
23
+ TODO: Write usage instructions here
24
+
25
+ ## Development
26
+
27
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
28
+
29
+ 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).
30
+
31
+ ## Contributing
32
+
33
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/riddler. 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.
34
+
35
+ ## License
36
+
37
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
38
+
39
+ ## Code of Conduct
40
+
41
+ Everyone interacting in the Riddler project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/riddler/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task default: :test
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "riddler"
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,19 @@
1
+ require "riddler/version"
2
+
3
+ require "liquid"
4
+
5
+ require "riddler/context"
6
+
7
+ require "riddler/element"
8
+ require "riddler/elements/copy"
9
+ require "riddler/elements/heading"
10
+
11
+ require "riddler/step"
12
+ require "riddler/steps/content"
13
+
14
+ require "riddler/use_cases/preview_step"
15
+
16
+ module Riddler
17
+ class Error < StandardError; end
18
+ # Your code goes here...
19
+ end
@@ -0,0 +1,24 @@
1
+ module Riddler
2
+
3
+ class Context
4
+ attr_reader :variables
5
+
6
+ def initialize input = nil
7
+ input ||= {}
8
+ @variables = {}
9
+ input.each do |key, value|
10
+ assign key, value
11
+ end
12
+ end
13
+
14
+ def assign name, value
15
+ variables[name.to_s] = value
16
+ end
17
+
18
+ def render string
19
+ template = ::Liquid::Template.parse string
20
+ template.render variables
21
+ end
22
+ end
23
+
24
+ end
@@ -0,0 +1,37 @@
1
+ module Riddler
2
+
3
+ class Element
4
+ attr_reader :definition, :context
5
+
6
+ def self.for definition, context
7
+ # This should be "type" not "object"
8
+ element_type = definition["object"]
9
+
10
+ # Maybe this should be a registry
11
+ klass = subclasses.detect { |klass| klass.type == element_type }
12
+
13
+ klass.new definition, context
14
+ end
15
+
16
+ def initialize definition, context
17
+ @definition = definition
18
+ @context = context
19
+ end
20
+
21
+ #def id
22
+ # definition["id"]
23
+ #end
24
+
25
+ #def type
26
+ # self.class.type
27
+ #end
28
+
29
+ def to_hash
30
+ {
31
+ type: self.class.type,
32
+ id: definition["id"]
33
+ }
34
+ end
35
+ end
36
+
37
+ end
@@ -0,0 +1,19 @@
1
+ module Riddler
2
+ module Elements
3
+
4
+ class Copy < ::Riddler::Element
5
+ def self.type
6
+ "copy"
7
+ end
8
+
9
+ def text
10
+ context.render definition["text"]
11
+ end
12
+
13
+ def to_hash
14
+ super.merge text: text
15
+ end
16
+ end
17
+
18
+ end
19
+ end
@@ -0,0 +1,19 @@
1
+ module Riddler
2
+ module Elements
3
+
4
+ class Heading < ::Riddler::Element
5
+ def self.type
6
+ "heading"
7
+ end
8
+
9
+ def text
10
+ context.render definition["text"]
11
+ end
12
+
13
+ def to_hash
14
+ super.merge text: text
15
+ end
16
+ end
17
+
18
+ end
19
+ end
@@ -0,0 +1,37 @@
1
+ module Riddler
2
+
3
+ class Step
4
+ attr_reader :definition, :context
5
+
6
+ def self.for definition, context
7
+ # This should be "type" not "object"
8
+ step_type = definition["object"]
9
+
10
+ # Maybe this should be a registry
11
+ klass = subclasses.detect { |klass| klass.type == step_type }
12
+
13
+ klass.new definition, context
14
+ end
15
+
16
+ def initialize definition, context
17
+ @definition = definition
18
+ @context = context
19
+ end
20
+
21
+ #def id
22
+ # definition["id"]
23
+ #end
24
+
25
+ #def type
26
+ # self.class.type
27
+ #end
28
+
29
+ def to_hash
30
+ {
31
+ type: self.class.type,
32
+ id: definition["id"]
33
+ }
34
+ end
35
+ end
36
+
37
+ end
@@ -0,0 +1,25 @@
1
+ module Riddler
2
+ module Steps
3
+
4
+ class Content < ::Riddler::Step
5
+ def self.type
6
+ "content"
7
+ end
8
+
9
+ def elements
10
+ @elements ||= definition["elements"].map do |element_definition|
11
+ ::Riddler::Element.for element_definition, context
12
+ end
13
+ end
14
+
15
+ def to_hash
16
+ hash = super
17
+ hash["elements"] = elements.map do |element|
18
+ element.to_hash
19
+ end
20
+ hash
21
+ end
22
+ end
23
+
24
+ end
25
+ end
@@ -0,0 +1,19 @@
1
+ module Riddler
2
+ module UseCases
3
+
4
+ class PreviewStep
5
+ attr_reader :definition, :context, :step
6
+
7
+ def initialize definition, context = ::Riddler::Context.new
8
+ @definition = definition
9
+ @context = context
10
+ @step = ::Riddler::Step.for definition, context
11
+ end
12
+
13
+ def process
14
+ step.to_hash
15
+ end
16
+ end
17
+
18
+ end
19
+ end
@@ -0,0 +1,3 @@
1
+ module Riddler
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,43 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "riddler/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "riddler"
8
+ spec.version = Riddler::VERSION
9
+ spec.authors = ["JohnnyT"]
10
+ spec.email = ["ubergeek3141@gmail.com"]
11
+
12
+ spec.summary = %q{Dynamic content and workflow engine}
13
+ spec.homepage = "https://github.com/riddler/riddler"
14
+ spec.license = "MIT"
15
+
16
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
17
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
18
+ if spec.respond_to?(:metadata)
19
+ spec.metadata["homepage_uri"] = spec.homepage
20
+ spec.metadata["source_code_uri"] = spec.homepage
21
+ spec.metadata["changelog_uri"] = [spec.metadata["source_code_uri"], "CHANGELOG.md"].join "/"
22
+ else
23
+ raise "RubyGems 2.0 or newer is required to protect against " \
24
+ "public gem pushes."
25
+ end
26
+
27
+ # Specify which files should be added to the gem when it is released.
28
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
29
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
30
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
31
+ end
32
+ spec.bindir = "exe"
33
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
34
+ spec.require_paths = ["lib"]
35
+
36
+ spec.add_dependency "ksuid"
37
+ spec.add_dependency "liquid"
38
+
39
+ spec.add_development_dependency "bundler", "~> 1.17"
40
+ spec.add_development_dependency "guard"
41
+ spec.add_development_dependency "minitest", "~> 5.0"
42
+ spec.add_development_dependency "rake", "~> 10.0"
43
+ end
metadata ADDED
@@ -0,0 +1,151 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: riddler
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - JohnnyT
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-12-13 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: ksuid
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: liquid
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.17'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.17'
55
+ - !ruby/object:Gem::Dependency
56
+ name: guard
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: minitest
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '5.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '5.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rake
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '10.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '10.0'
97
+ description:
98
+ email:
99
+ - ubergeek3141@gmail.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".travis.yml"
106
+ - CODE_OF_CONDUCT.md
107
+ - Gemfile
108
+ - Gemfile.lock
109
+ - LICENSE.txt
110
+ - README.md
111
+ - Rakefile
112
+ - bin/console
113
+ - bin/setup
114
+ - lib/riddler.rb
115
+ - lib/riddler/context.rb
116
+ - lib/riddler/element.rb
117
+ - lib/riddler/elements/copy.rb
118
+ - lib/riddler/elements/heading.rb
119
+ - lib/riddler/step.rb
120
+ - lib/riddler/steps/content.rb
121
+ - lib/riddler/use_cases/preview_step.rb
122
+ - lib/riddler/version.rb
123
+ - riddler.gemspec
124
+ homepage: https://github.com/riddler/riddler
125
+ licenses:
126
+ - MIT
127
+ metadata:
128
+ homepage_uri: https://github.com/riddler/riddler
129
+ source_code_uri: https://github.com/riddler/riddler
130
+ changelog_uri: https://github.com/riddler/riddler/CHANGELOG.md
131
+ post_install_message:
132
+ rdoc_options: []
133
+ require_paths:
134
+ - lib
135
+ required_ruby_version: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ version: '0'
140
+ required_rubygems_version: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - ">="
143
+ - !ruby/object:Gem::Version
144
+ version: '0'
145
+ requirements: []
146
+ rubyforge_project:
147
+ rubygems_version: 2.7.6
148
+ signing_key:
149
+ specification_version: 4
150
+ summary: Dynamic content and workflow engine
151
+ test_files: []