microdata_schema 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8896cf100b207165698b01958665fcdab98cf158
+  data.tar.gz: 1a7191e5223562b33e4daf9eac50cff5992adc9a
+SHA512:
+  metadata.gz: d47e7abe26e14c2c7ae593b1004a852fb9c664692713b1f9a24589248ae5da679444f3799266397ea22144892e9f0878af331d0de670c8f1e39e1fb59d4c8326
+  data.tar.gz: 06bf38a029ee9fefe2a73a66d61cc6bbfbf7670d28e3d5529be76b5711aa47d2f8975e624813b2a178f3e40916d056268ab87147f3cbc0cb9aa348d3241cfb1e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 source.coed.tech@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in microdata_schema.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 co-ed
+
+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,43 @@
+# MicrodataSchema
+
+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/microdata_schema`. 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 'microdata_schema'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install microdata_schema
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/microdata_schema. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MicrodataSchema project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/microdata_schema/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "microdata_schema"
+
+# 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/lib/microdata.rb

@@ -0,0 +1,4 @@
+require 'microdata/schema'
+
+module Microdata
+end

data/lib/microdata/schema.rb

@@ -0,0 +1,121 @@
+module Microdata
+  class Schema
+    attr_reader :assined_attributes
+    attr_writer :top_level
+
+    def initialize(*args)
+      @top_level = true
+      @required_attributes_for_top_level_things = {
+        '@context' => "http://schema.org",
+      }
+      @required_attributes = {
+        '@type' => self.class.to_s.split(/::/).last
+      }
+      @assined_attributes = []
+    end
+
+    def to_json_ld
+    end
+
+    autoload :List,               'microdata/schema/list'
+    autoload :Thing,              'microdata/schema/thing'
+    autoload :Action,             'microdata/schema/thing/action'
+    autoload :AchieveAction,      'microdata/schema/thing/action/achieve_action'
+    autoload :LoseAction,         'microdata/schema/thing/action/achieve_action/lose_action'
+    autoload :TieAction,          'microdata/schema/thing/action/achieve_action/tie_action'
+    autoload :WinAction,          'microdata/schema/thing/action/achieve_action/win_action'
+    autoload :AssessAction,       'microdata/schema/thing/action/assess_action'
+    autoload :ChooseAction,       'microdata/schema/thing/action/assess_action/choose_action'
+    autoload :VoteAction,         'microdata/schema/thing/action/assess_action/choose_action/vote_action'
+    autoload :IgnoreAction,       'microdata/schema/thing/action/assess_action/ignore_action'
+    autoload :ReactAction,        'microdata/schema/thing/action/assess_action/react_action'
+    autoload :AgreeAction,        'microdata/schema/thing/action/assess_action/react_action/agree_action'
+    autoload :DisagreeAction,     'microdata/schema/thing/action/assess_action/react_action/disagree_action'
+    autoload :DislikeAction,      'microdata/schema/thing/action/assess_action/react_action/dislike_action'
+    autoload :EndorseAction,      'microdata/schema/thing/action/assess_action/react_action/endorsee_action'
+    autoload :LikeAction,         'microdata/schema/thing/action/assess_action/react_action/like_action'
+    autoload :WantAction,         'microdata/schema/thing/action/assess_action/react_action/want_action'
+    autoload :ReviewAction,       'microdata/schema/thing/action/assess_action/review_action'
+    autoload :ConsumeAction,      'microdata/schema/thing/action/consume_action'
+    autoload :DrinkAction,        'microdata/schema/thing/action/consume_action/drink_action'
+    autoload :EatAction,          'microdata/schema/thing/action/consume_action/eat_action'
+    autoload :InstallAction,      'microdata/schema/thing/action/consume_action/install_action'
+    autoload :ListenAction,       'microdata/schema/thing/action/consume_action/listen_action'
+    autoload :ReadAction,         'microdata/schema/thing/action/consume_action/read_action'
+    autoload :UseAction,          'microdata/schema/thing/action/consume_action/use_action'
+    autoload :WearAction,         'microdata/schema/thing/action/consume_action/use_action/wear_action'
+    autoload :ViewAction,         'microdata/schema/thing/action/consume_action/view_action'
+    autoload :WatchAction,        'microdata/schema/thing/action/consume_action/watch_action'
+    autoload :ControlAction,      'microdata/schema/thing/action/control_action'
+    autoload :ActivateAction,     'microdata/schema/thing/action/control_action/activate_action'
+    autoload :DeactivateAction,   'microdata/schema/thing/action/control_action/deactivate_action'
+    autoload :ResumeAction,       'microdata/schema/thing/action/control_action/resume_action'
+    autoload :SuspendAction,      'microdata/schema/thing/action/control_action/suspend_action'
+    autoload :CreateAction,       'microdata/schema/thing/action/create_action'
+    autoload :CookAction,         'microdata/schema/thing/action/create_action/cook_action'
+    autoload :DrawAction,         'microdata/schema/thing/action/create_action/draw_action'
+    autoload :FilmAction,         'microdata/schema/thing/action/create_action/film_action'
+    autoload :PaintAction,        'microdata/schema/thing/action/create_action/paint_action'
+    autoload :PhotographAction,   'microdata/schema/thing/action/create_action/photograph_action'
+    autoload :WriteAction,        'microdata/schema/thing/action/create_action/write_action'
+    autoload :FindAction,         'microdata/schema/thing/action/find_action'
+    autoload :CheckAction,        'microdata/schema/thing/action/find_action/check_action'
+    autoload :DiscoverAction,     'microdata/schema/thing/action/find_action/discover_action'
+    autoload :TrackAction,        'microdata/schema/thing/action/find_action/track_action'
+    autoload :InteractAction,     'microdata/schema/thing/action/interact_action'
+    autoload :BefriendAction,     'microdata/schema/thing/action/interact_action/befriend_action'
+    autoload :CommunicateAction,  'microdata/schema/thing/action/interact_action/communicate_action'
+    autoload :AskAction,          'microdata/schema/thing/action/interact_action/communicate_action/ask_action'
+    autoload :CheckInAction,      'microdata/schema/thing/action/interact_action/communicate_action/check_in_action'
+    autoload :CheckOutAction,     'microdata/schema/thing/action/interact_action/communicate_action/check_out_action'
+    autoload :CommentAction,      'microdata/schema/thing/action/interact_action/communicate_action/comment_action'
+    autoload :InformAction,       'microdata/schema/thing/action/interact_action/communicate_action/inform_action'
+    autoload :ConfirmAction,      'microdata/schema/thing/action/interact_action/communicate_action/inform_action/confirm_action'
+    autoload :RsvpAction,         'microdata/schema/thing/action/interact_action/communicate_action/inform_action/rsvp_action'
+    autoload :InviteAction,       'microdata/schema/thing/action/interact_action/communicate_action/invite_action'
+    autoload :ReplyAction,        'microdata/schema/thing/action/interact_action/communicate_action/reply_action'
+    autoload :ShareAction,        'microdata/schema/thing/action/interact_action/communicate_action/share_action'
+    autoload :FollowAction,       'microdata/schema/thing/action/interact_action/follow_action'
+    autoload :JoinAction,         'microdata/schema/thing/action/interact_action/join_action'
+    autoload :LeaveAction,        'microdata/schema/thing/action/interact_action/leave_action'
+    autoload :MarryAction,        'microdata/schema/thing/action/interact_action/marry_action'
+    autoload :RegisterAction,     'microdata/schema/thing/action/interact_action/register_action'
+    autoload :SubscribeAction,    'microdata/schema/thing/action/interact_action/subscribe_action'
+    autoload :UnRegisterAction,   'microdata/schema/thing/action/interact_action/un_register_action'
+    autoload :MoveAction,         'microdata/schema/thing/action/move_action'
+    autoload :ArriveAction,       'microdata/schema/thing/action/move_action/arrive_action'
+    autoload :DepartAction,       'microdata/schema/thing/action/move_action/depart_action'
+    autoload :TravelAction,       'microdata/schema/thing/action/move_action/travel_action'
+    autoload :OrganizeAction,     'microdata/schema/thing/action/organize_action'
+    autoload :AllocateAction,     'microdata/schema/thing/action/organize_action/allocate_action'
+    autoload :AcceptAction,       'microdata/schema/thing/action/organize_action/allocate_action/accept_action'
+    autoload :AssignAction,       'microdata/schema/thing/action/organize_action/allocate_action/assign_action'
+    autoload :AuthorizeAction,    'microdata/schema/thing/action/organize_action/allocate_action/authorize_action'
+    autoload :RejectAction,       'microdata/schema/thing/action/organize_action/allocate_action/reject_action'
+    autoload :ApplyAction,        'microdata/schema/thing/action/organize_action/apply_action'
+    autoload :BookmarkAction,     'microdata/schema/thing/action/organize_action/bookmark_action'
+    autoload :PlanAction,         'microdata/schema/thing/action/organize_action/plan_action'
+    autoload :CancelAction,       'microdata/schema/thing/action/organize_action/plan_action/cancel_action'
+    autoload :ReserveAction,      'microdata/schema/thing/action/organize_action/plan_action/reserve_action'
+    autoload :ScheduleAction,     'microdata/schema/thing/action/organize_action/plan_action/schedule_action'
+    autoload :PlayAction, 		    'microdata/schema/thing/action/play_action'
+
+    autoload :CreativeWork,       'microdata/schema/thing/creative_work'
+    autoload :Article,            'microdata/schema/thing/creative_work/article'
+    autoload :TechArticle,        'microdata/schema/thing/creative_work/article/tech_article'
+    autoload :SoftwareSourceCode, 'microdata/schema/thing/creative_work/software_source_code'
+    autoload :WebPage,            'microdata/schema/thing/creative_work/web_page'
+    autoload :AboutPage,          'microdata/schema/thing/creative_work/web_page/about_page'
+    autoload :ProfilePage,        'microdata/schema/thing/creative_work/web_page/profile_page'
+    autoload :WebSite,            'microdata/schema/thing/creative_work/web_site'
+    autoload :Event,              'microdata/schema/thing/event'
+    autoload :Intangible,         'microdata/schema/thing/intangible'
+    autoload :ItemList,           'microdata/schema/thing/intangible/item_list'
+    autoload :BreadcrumbList,     'microdata/schema/thing/intangible/item_list/breadcrumb_list'
+    autoload :ListItem,           'microdata/schema/thing/intangible/list_item'
+    autoload :Organization,       'microdata/schema/thing/organization'
+    autoload :Person,             'microdata/schema/thing/person'
+    autoload :Place,              'microdata/schema/thing/place'
+    autoload :Product,            'microdata/schema/thing/product'
+  end
+end

data/lib/microdata/schema/data_type/boolean.rb

@@ -0,0 +1,10 @@
+module Microdata
+  module Schema
+    class Boolean < ::Boolean
+      VALUES = [
+        True,
+        False
+      ]
+    end
+  end
+end

data/lib/microdata/schema/data_type/boolean/false.rb

@@ -0,0 +1,6 @@
+module Microdata
+  module Schema
+    class False < ::FalseClass
+    end
+  end
+end

data/lib/microdata/schema/data_type/boolean/true.rb

@@ -0,0 +1,6 @@
+module Microdata
+  module Schema
+    class True < ::TrueClass
+    end
+  end
+end

data/lib/microdata/schema/data_type/date.rb

@@ -0,0 +1,10 @@
+module Microdata
+  module Schema
+    class Date < ::Date
+      def to_s
+        # DateTime  The end date and time of the item (in ISO 8601 date format).
+        self.to_iso8601
+      end
+    end
+  end
+end

data/lib/microdata/schema/data_type/date_time.rb

@@ -0,0 +1,10 @@
+module Microdata
+  module Schema
+    class DateTime < ::DateTime
+      def to_s
+        # DateTime  The end date and time of the item (in ISO 8601 date format).
+        self.to_iso8601
+      end
+    end
+  end
+end

data/lib/microdata/schema/data_type/number.rb

@@ -0,0 +1,6 @@
+module Microdata
+  module Schema
+    class Number < ::Number
+    end
+  end
+end

data/lib/microdata/schema/data_type/number/float.rb

@@ -0,0 +1,6 @@
+module Microdata
+  module Schema
+    class Float < ::Float
+    end
+  end
+end

data/lib/microdata/schema/data_type/number/integer.rb

@@ -0,0 +1,6 @@
+module Microdata
+  module Schema
+    class Integer < ::Integer
+    end
+  end
+end

data/lib/microdata/schema/data_type/text.rb

@@ -0,0 +1,6 @@
+module Microdata
+  module Schema
+    class Text < ::String
+    end
+  end
+end

data/lib/microdata/schema/data_type/text/url.rb

@@ -0,0 +1,6 @@
+module Microdata
+  module Schema
+    class URL < ::String
+    end
+  end
+end

data/lib/microdata/schema/data_type/time.rb

@@ -0,0 +1,6 @@
+module Microdata
+  module Schema
+    class Time < ::Time
+    end
+  end
+end

data/lib/microdata/schema/list.rb

@@ -0,0 +1,9 @@
+module Microdata
+  class Schema
+    class List < Array
+      def to_json_ld(options = nil)
+        "<script type=\"application/ld+json\">" + to_json(options) + "</script>"
+      end
+    end
+  end
+end

data/lib/microdata/schema/thing.rb

@@ -0,0 +1,98 @@
+module Microdata
+  class Schema
+    class Thing < Schema
+      ATTRIBUTES = [:id, :additional_type, :alternate_name, :description, :disambiguating_description, :identifier, :image, :main_entity_of_page, :name, :potential_action, :same_as, :url].freeze
+      class_attribute :attributes
+      self.attributes = ATTRIBUTES
+
+      def initialize(*args)
+        hash = args.first
+        return super if hash.nil?
+        raise "args needs Hash" if hash.class != Hash
+        super
+        hash.each do |key, value|
+          raise "key not found (#{key})" unless attributes.include?(key)
+          value.top_level = false if value.is_a? Thing
+          instance_variable_set("@#{key}", value)
+          @assined_attributes << key
+        end
+      end
+
+      def as_json(options = nil)
+        hash = {}
+        assined_attributes.each do |attribute|
+          camelCase = to_camel_case(attribute.to_s)
+          camelCase = "@id" if camelCase == "id"
+          hash[camelCase] = instance_variable_get("@#{attribute}")
+        end
+        hash = @required_attributes.merge(hash)
+        if @top_level
+          @required_attributes_for_top_level_things.merge!(hash)
+          @required_attributes_for_top_level_things
+        else
+          hash
+        end
+      end
+
+      def to_json(options = nil)
+        as_json(options).to_json
+      end
+
+      def to_json_ld(options = nil)
+        "<script type=\"application/ld+json\">" + to_json(options) + "</script>"
+      end
+
+      private
+
+        def to_camel_case(string)
+          _words = []
+          words = string.split("_")
+          _words << words.shift
+          words.each.with_index do |word|
+            word[0] = word[0].upcase
+            _words << word
+          end
+          _words.join
+        end
+
+# - additional_type
+#   URL  An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
+#
+# - alternate_name
+#   Text  An alias for the item.
+#
+# - description
+#   Text  A description of the item.
+#
+# - disambiguating_description
+#   Text  A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
+#
+# - identifier
+#   PropertyValue  or 
+#   Text  or 
+#   URL  The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
+#
+# - image
+#   ImageObject  or 
+#   URL  An image of the item. This can be a URL or a fully described ImageObject.
+#
+# - main_entity_of_page
+#   CreativeWork  or 
+#   URL  Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
+#   Inverse property: mainEntity.
+#
+# - name
+#   Text  The name of the item.
+#
+# - potential_action
+#   Action  Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
+#
+# - same_as
+#   URL  URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
+#
+# - url
+#   URL  URL of the item.
+# 
+    end
+  end
+end