Add ContentSuggestion, ContentSuggestionCategory and ContentSuggestionProviderType

components/ntp_snippets/ntp_snippet.h

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef COMPONENTS_NTP_SNIPPETS_NTP_SNIPPET_H_
 #define COMPONENTS_NTP_SNIPPETS_NTP_SNIPPET_H_
 
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/time/time.h"
+#include "components/ntp_snippets/snippet.h"
 #include "url/gurl.h"
 
 namespace base {
 class DictionaryValue;
 class ListValue;
 }
 
 namespace ntp_snippets {
 
 class SnippetProto;
 
 struct SnippetSource {
   SnippetSource(const GURL& url,
                 const std::string& publisher_name,
                 const GURL& amp_url)
       : url(url), publisher_name(publisher_name), amp_url(amp_url) {}
   GURL url;
   std::string publisher_name;
   GURL amp_url;
 };
 
+// TODO IMPORTANT NOTE: This class will move to a sub-namespace and be renamed

[Marc Treib, 2016/06/13 13:08:17]

TODOs should always have someone assigned, as in:
// TODO(pke): ...
(this exact format, for easy greppability etc)

I'd split this into two parts, the "IMPORTANT NOTE" (for other devs), and then a
TODO for yourself to actually do the rename.

However: Right now, this comment references a class that doesn't exist yet
("SnippetService"). That's the kind of inconsistency we'd like to avoid. So, two
options:
- Add the new SnippetsService class in this CL too, or
- remove this comment again, and add it back in the CL that actually adds the
SnippetsService.

[Philipp Keck, 2016/06/13 14:13:14]

Done.

[Philipp Keck, 2016/06/13 14:13:14]

Ok. I don't need the TODO comment for myself because that's the next thing I'm
doing anyway, so it's on my private todo list. I just added it because many IDEs
will then highlight the line, but in that case I'll just remove the TODO marker.

I will remove those comments and re-add them when necessary.

+// ArticleSnippet. It will only be used for snippets from Chrome Reader.
+// When accessing snippets for all usages towards the UI, use the new "Snippet"
+// class through the "SnippetService" instead.
+
 class NTPSnippet {
  public:
   using PtrVector = std::vector<std::unique_ptr<NTPSnippet>>;
 
   // Creates a new snippet with the given |id|.
   // Public for testing only - create snippets using the Create* methods below.
   // TODO(treib): Make this private and add a CreateSnippetForTest?
   NTPSnippet(const std::string& id);
 
   ~NTPSnippet();
@@ skipping 73 matching lines @@
            !publish_date().is_null() && !expiry_date().is_null() &&
            !best_source().publisher_name.empty();
   }
 
   float score() const { return score_; }
   void set_score(float score) { score_ = score; }
 
   bool is_discarded() const { return is_discarded_; }
   void set_discarded(bool discarded) { is_discarded_ = discarded; }
 
+  // TODO IMPORTANT NOTE This method is confusingly named because of upcoming
+  // changes to the names: NTPSnippet will become ArticleSnippet.
+  // TODO (pke) Instead of converting, ArticleSnippet might inherit Snippet?

[Marc Treib, 2016/06/13 13:08:17]

Probably not :)  But anyway, this is the kind of thing that's better served by a
personal todo list, rather than a comment in the code.

[Philipp Keck, 2016/06/13 14:13:14]

Done.

+  std::unique_ptr<Snippet> ToSnippet() const;
+
   // Public for testing.
   static base::Time TimeFromJsonString(const std::string& timestamp_str);
   static std::string TimeToJsonString(const base::Time& time);
 
  private:
   void FindBestSource();
 
   std::string id_;
   std::string title_;
   GURL salient_image_url_;
   std::string snippet_;
   base::Time publish_date_;
   base::Time expiry_date_;
   float score_;
   bool is_discarded_;
 
   size_t best_source_index_;
 
   std::vector<SnippetSource> sources_;
 
   DISALLOW_COPY_AND_ASSIGN(NTPSnippet);
 };
 
 }  // namespace ntp_snippets
 
 #endif  // COMPONENTS_NTP_SNIPPETS_NTP_SNIPPET_H_