dynamic_text_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98c7e572da6db2dbffdd292dd361d6c28eff5dbf9ba435fa623c89106090d448
+  data.tar.gz: e1ba3fb349c7ab0f1b6242fa5b4960f3a2bd4b113328ab5900bee0387cf4b318
+SHA512:
+  metadata.gz: fb2d288302852ca4c4b41baf3ff51211c20aca238d647275bd48cd6028d157359516c38adfe5c34e87a8506a8af6027c2062bba96062b71ad7ccde5a1a09099e
+  data.tar.gz: c1d8dd38a824f604f0dc1935ff3f5f72bfd7213e222ccb66c072eb11f7ba07254b46f7955b375a3b972a0d0d61cd0a45a227aeecf2e42e2a86dac24bd2d29617

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

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 shunsuke.yamada@glv.co.jp. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dynamic_text_generator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    dynamic_text_generator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 2.0)
+  dynamic_text_generator!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 山田 俊輔
+
+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,132 @@
+# DynamicTextGenerator
+A library for dynamically generating text from template with variables embedded stored in the RDB.
+It is intended to generate text for use in mail and push notifications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dynamic_text_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynamic_text_generator
+
+## Usage
+
+### Table and model for stored template 
+Create table and model for stored template 
+
+```rb
+class TemplateModel < ApplicationRecord
+end
+```
+
+### Class definition to use template
+Following 4 steps.
+
+1. Include `DynamicTextGenerator::Generatable` module.
+2. Define template model, corresponding to the table in which the template is stored.
+3. Define template columns, columns of the model defined above in which the template is stored.
+4. Add `initialize` method to set '@template_id' and  '@instance_for_template'
+
+It is possible to call method `"text_#{template_column}"` for example `text_attr1`
+
+```rb
+class MyClass
+  # 1
+  include DynamicTextGenerator::Generatable
+  
+  # 2
+  template_model :template_model
+  # 3
+  template_columns :attr1, :attr2
+  
+  # 4
+  def initialize(template_id, template_obj)
+    @template_id = template_id
+    @instance_for_template = template_obj
+  end
+  
+  def do_something
+    {
+      title: text_attr1,
+      body:  text_attr2,
+    }
+  end
+end
+```
+
+### Example
+
+#### Template table and data
+
+table name: notice_temlates
+
+|id|tilte|content|
+|---:|:---|:---|
+|1|%{obj.title} Digest|Topic: %{obj.content_name}. URL:%{obj.url}|
+|2|%{obj.title} Campaign|Campaign code: %{obj.campaign_code}. URL:%{obj.url}|
+
+#### Obj for template
+Obj for template must be respond to methods embedded in template.
+
+```rb
+obj1 = OpenStruct.new({ title => "Daily", contet_name: "Daily news", url: "https://foo.bar/news"  })
+obj2 = OpenStruct.new({ title => "Limited time sale", campaign_code: "123456", url: "https://foo.bar/campaigns"  })
+```
+
+#### Class definition
+
+```rb
+class MyClass
+  include DynamicTextGenerator::Generatable
+  
+  template_model :notice_template
+  template_columns :title, :content
+  
+  def initialize(template_id, template_obj)
+    @template_id = template_id
+    @instance_for_template = template_obj
+  end
+  
+  def do_something
+    {
+      title: text_title,
+      body:  text_content,
+    }
+  end
+end
+```
+
+#### run
+
+```rb
+instance1 = MyClass.new(1, obj1)
+instance1.text_title # => Daily Digest
+instance1.text_content # => Topic: Daily news. URL:https://foo.bar/news
+
+instance2 = MyClass.new(2, obj2)
+instance2.text_title # => Limited time sale Campaign
+instance2.text_content # => Campaign code: 123456. URL:https://foo.bar/campaigns
+instance2.do_something # => { titel: "Limited time sale Campaign", body: "Campaign code: 123456. URL:https://foo.bar/campaigns" }
+```
+
+
+## Development
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dynamic_text_generator. 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).

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 "dynamic_text_generator"
+
+# 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/dynamic_text_generator.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dynamic_text_generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dynamic_text_generator"
+  spec.version       = DynamicTextGenerator::VERSION
+  spec.authors       = ["山田 俊輔"]
+  spec.email         = ["yshunske@gmail.com"]
+
+  spec.summary       = %q{For Rails app, dynamically generate text, such as the body of a mail, from data stored in the RDB.}
+  spec.homepage      = "https://github.com/yamashun/dynamic_text_generator"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/yamashun/dynamic_text_generator"
+    spec.metadata["changelog_uri"] = "https://github.com/yamashun/dynamic_text_generator/blob/master/README.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activesupport"
+end

data/lib/dynamic_text_generator.rb

@@ -0,0 +1,50 @@
+require "dynamic_text_generator/version"
+
+module DynamicTextGenerator
+  class Error < StandardError; end
+  # Your code goes here...
+  module Generatable
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def template_model(template_model)
+        @template_model_class = Object.const_get(template_model.to_s.camelize)
+      end
+
+      def template_columns(*args)
+        args.each do |column_name|
+          define_method "text_#{column_name.to_s}" do
+            generate_template(notice_template.send(column_name), @instance_for_template)
+          end
+        end
+      end
+    end
+
+    private
+
+    def notice_template
+      @notice_template ||= self.class.instance_variable_get("@template_model_class").find(@template_id)
+    end
+
+    def generate_template(template, obj)
+      merge_params(template, obj).each do |key, value|
+        template.gsub!(key, value.to_s)
+      end
+      template
+    end
+
+    def merge_params(body, obj)
+      params = {}
+      body.scan(/%{[\@\w\.]+}/).map do |key|
+        params[key] = nil
+      end
+      return params if params.size == 0
+      params.each do |key, _|
+        params[key] = eval(key[2..-2])
+      end
+      params
+    end
+  end
+end

data/lib/dynamic_text_generator/version.rb

@@ -0,0 +1,3 @@
+module DynamicTextGenerator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: dynamic_text_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 山田 俊輔
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- yshunske@gmail.com
+executables: []
+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
+- dynamic_text_generator.gemspec
+- lib/dynamic_text_generator.rb
+- lib/dynamic_text_generator/version.rb
+homepage: https://github.com/yamashun/dynamic_text_generator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yamashun/dynamic_text_generator
+  source_code_uri: https://github.com/yamashun/dynamic_text_generator
+  changelog_uri: https://github.com/yamashun/dynamic_text_generator/blob/master/README.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: For Rails app, dynamically generate text, such as the body of a mail, from
+  data stored in the RDB.
+test_files: []